Class: OCI::Identity::Models::UpdateSaml2IdentityProviderDetails

Inherits:
UpdateIdentityProviderDetails show all
Defined in:
lib/oci/identity/models/update_saml2_identity_provider_details.rb

Overview

UpdateSaml2IdentityProviderDetails model.

Constant Summary

Constants inherited from UpdateIdentityProviderDetails

OCI::Identity::Models::UpdateIdentityProviderDetails::PROTOCOL_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateIdentityProviderDetails

#defined_tags, #description, #freeform_tags, #protocol

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateIdentityProviderDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSaml2IdentityProviderDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description proprety

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

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

  • :metadata_url (String) —

    The value to assign to the #metadata_url property

  • :metadata (String) —

    The value to assign to the #metadata property

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

    The value to assign to the #freeform_attributes property



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 71

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

  attributes['protocol'] = 'SAML2'

  super(attributes)

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

  self.metadata_url = attributes[:'metadataUrl'] if attributes[:'metadataUrl']

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

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

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

  self.freeform_attributes = attributes[:'freeformAttributes'] if attributes[:'freeformAttributes']

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

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

Instance Attribute Details

#freeform_attributes ⇒ Hash<String, String>

Extra name value pairs associated with this identity provider. Example: {\"clientId\": \"app_sf3kdjf3\"}

Returns:

  • (Hash<String, String>) 


27
28
29
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 27

def freeform_attributes
  @freeform_attributes
end

#metadata ⇒ String

The XML that contains the information required for federating.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 21

def metadata
  @metadata
end

#metadata_url ⇒ String

The URL for retrieving the identity provider's metadata, which contains information required for federating.

Returns:

  • (String) 


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

def metadata_url
  @metadata_url
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'protocol',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'metadata_url': :'metadataUrl',
    'metadata': :'metadata',
    'freeform_attributes': :'freeformAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'metadata_url': :'String',
    'metadata': :'String',
    'freeform_attributes': :'Hash<String, String>'
    # 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



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 103

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

  self.class == other.class &&
    protocol == other.protocol &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    metadata_url == other.metadata_url &&
    metadata == other.metadata &&
    freeform_attributes == other.freeform_attributes
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 139

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


119
120
121
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 128

def hash
  [protocol, description, freeform_tags, defined_tags, metadata_url, metadata, freeform_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 172

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



166
167
168
 
# File 'lib/oci/identity/models/update_saml2_identity_provider_details.rb', line 166

def to_s
  to_hash.to_s
end