Class: OCI::Identity::Models::CreateIdentityProviderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/create_identity_provider_details.rb

Overview

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateSaml2IdentityProviderDetails

Constant Summary collapse

PRODUCT_TYPE_ENUM = 
[PRODUCT_TYPE_IDCS = 'IDCS',
PRODUCT_TYPE_ADFS = 'ADFS']
PROTOCOL_ENUM = 
[PROTOCOL_SAML2 = 'SAML2']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIdentityProviderDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :product_type (String) —

    The value to assign to the #product_type property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  if attributes[:'compartment_id']
    self.compartment_id = attributes[:'compartment_id']
  end

  if attributes[:'name']
    self.name = attributes[:'name']
  end

  if attributes[:'description']
    self.description = attributes[:'description']
  end

  if attributes[:'productType']
    self.product_type = attributes[:'productType']
  end

  raise 'You cannot provide both :productType and :product_type' if attributes.key?(:'productType') && attributes.key?(:'product_type')

  if attributes[:'product_type']
    self.product_type = attributes[:'product_type']
  end

  if attributes[:'protocol']
    self.protocol = attributes[:'protocol']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  if attributes[:'freeform_tags']
    self.freeform_tags = attributes[:'freeform_tags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  if attributes[:'defined_tags']
    self.defined_tags = attributes[:'defined_tags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of your tenancy.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 17

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


60
61
62
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 60

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description you assign to the ‘IdentityProvider` during creation. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 30

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


53
54
55
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 53

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] The name you assign to the ‘IdentityProvider` during creation. The name must be unique across all `IdentityProvider` objects in the tenancy and cannot be changed.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 24

def name
  @name
end

#product_type ⇒ String

[Required] The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).

Example: ‘IDCS`

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 39

def product_type
  @product_type
end

#protocol ⇒ String

[Required] The protocol used for federation.

Example: ‘SAML2`

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 46

def protocol
  @protocol
end

Class Method Details

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



65
66
67
68
69
70
71
72
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 65

def self.get_subtype(object_hash)
  type = object_hash[:'protocol']

  return 'OCI::Identity::Models::CreateSaml2IdentityProviderDetails' if type == 'SAML2'

  # TODO: Log a warning when the subtype is not found.
  return 'OCI::Identity::Models::CreateIdentityProviderDetails'
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 165

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      product_type == other_object.product_type &&
      protocol == other_object.protocol &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 192

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 179

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 185

def hash
  [compartment_id, name, description, product_type, protocol, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



211
212
213
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 211

def to_s
  to_hash.to_s
end