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

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

Overview

CreateIdentityProviderDetails model. 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'.freeze,
  PRODUCT_TYPE_ADFS = 'ADFS'.freeze
].freeze
PROTOCOL_ENUM = 
[
  PROTOCOL_SAML2 = 'SAML2'.freeze,
  PROTOCOL_ADFS = 'ADFS'.freeze
].freeze

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 127

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 }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of your tenancy.

Returns:

  • (String) 


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

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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


67
68
69
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 67

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) 


37
38
39
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 37

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. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

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) 


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

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) 


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

def product_type
  @product_type
end

#protocol ⇒ String

[Required] The protocol used for federation.

Example: SAML2

Returns:

  • (String) 


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

def protocol
  @protocol
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 70

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'product_type': :'productType',
    'protocol': :'protocol',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.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.



104
105
106
107
108
109
110
111
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 104

def self.get_subtype(object_hash)
  type = object_hash[:'protocol'] # rubocop:disable Style/SymbolLiteral

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

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

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'product_type': :'String',
    'protocol': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 187

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    description == other.description &&
    product_type == other.product_type &&
    protocol == other.protocol &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 223

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)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 203

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 256

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



250
251
252
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 250

def to_s
  to_hash.to_s
end