Class: OCI::Identity::Models::UpdateIdentityProviderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/update_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

UpdateSaml2IdentityProviderDetails

Constant Summary collapse

PROTOCOL_ENUM = 
[PROTOCOL_SAML2 = 'SAML2']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateIdentityProviderDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :protocol (String) —

    The value to assign to the #protocol property

  • :description (String) —

    The value to assign to the #description property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 56

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[:'protocol']
    self.protocol = attributes[:'protocol']
  end

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

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

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

end

Instance Attribute Details

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


36
37
38
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 36

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 22

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


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

def freeform_tags
  @freeform_tags
end

#protocol ⇒ String

[Required] The protocol used for federation.

Example: ‘SAML2`

Returns:

  • (String) 


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

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.



41
42
43
44
45
46
47
48
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 41

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

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

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

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



92
93
94
95
96
97
98
99
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 92

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      protocol == other_object.protocol &&
      description == other_object.description &&
      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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 116

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


103
104
105
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 103

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 109

def hash
  [protocol, description, 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



141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 141

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



135
136
137
 
# File 'lib/oci/identity/models/update_identity_provider_details.rb', line 135

def to_s
  to_hash.to_s
end