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

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

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 61

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

  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

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

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of your tenancy.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#name ⇒ String

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) 


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

def name
  @name
end

#product_type ⇒ String

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) 


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

def product_type
  @product_type
end

#protocol ⇒ String

The protocol used for federation.

Example: ‘SAML2`

Returns:

  • (String) 


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

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.



50
51
52
53
54
55
56
57
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 50

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



111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 111

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 136

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.send("#{key}=", 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.send("#{key}=", 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


123
124
125
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 123

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 129

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 161

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    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



155
156
157
 
# File 'lib/oci/identity/models/create_identity_provider_details.rb', line 155

def to_s
  to_hash.to_s
end