Class: OCI::Oda::Models::AuthenticationProviderSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/authentication_provider_summary.rb

Overview

Summary of the Authentication Provider.

Constant Summary collapse

GRANT_TYPE_ENUM = 
[
  GRANT_TYPE_CLIENT_CREDENTIALS = 'CLIENT_CREDENTIALS'.freeze,
  GRANT_TYPE_AUTHORIZATION_CODE = 'AUTHORIZATION_CODE'.freeze,
  GRANT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IDENTITY_PROVIDER_ENUM = 
[
  IDENTITY_PROVIDER_GENERIC = 'GENERIC'.freeze,
  IDENTITY_PROVIDER_OAM = 'OAM'.freeze,
  IDENTITY_PROVIDER_GOOGLE = 'GOOGLE'.freeze,
  IDENTITY_PROVIDER_MICROSOFT = 'MICROSOFT'.freeze,
  IDENTITY_PROVIDER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationProviderSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :grant_type (String) —

    The value to assign to the #grant_type property

  • :identity_provider (String) —

    The value to assign to the #identity_provider property

  • :name (String) —

    The value to assign to the #name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated 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



126
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 126

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.id = attributes[:'id'] if attributes[:'id']

  self.grant_type = attributes[:'grantType'] if attributes[:'grantType']

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

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

  self.identity_provider = attributes[:'identityProvider'] if attributes[:'identityProvider']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


75
76
77
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 75

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


69
70
71
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 69

def freeform_tags
  @freeform_tags
end

#grant_type ⇒ String

[Required] The grant type for the Authentication Provider.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 43

def grant_type
  @grant_type
end

#id ⇒ String

[Required] Unique immutable identifier that was assigned when the Authentication Provider was created.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 39

def id
  @id
end

#identity_provider ⇒ String

[Required] Which type of Identity Provider (IDP) you are using.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 47

def identity_provider
  @identity_provider
end

#lifecycle_state ⇒ String

[Required] The Authentication Provider's current state.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] A name to identify the Authentication Provider.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 51

def name
  @name
end

#time_created ⇒ DateTime

[Required] When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 59

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 63

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'grant_type': :'grantType',
    'identity_provider': :'identityProvider',
    'name': :'name',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'grant_type': :'String',
    'identity_provider': :'String',
    'name': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 225

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

  self.class == other.class &&
    id == other.id &&
    grant_type == other.grant_type &&
    identity_provider == other.identity_provider &&
    name == other.name &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 263

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


243
244
245
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 243

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 252

def hash
  [id, grant_type, identity_provider, name, lifecycle_state, time_created, time_updated, 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



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 296

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



290
291
292
 
# File 'lib/oci/oda/models/authentication_provider_summary.rb', line 290

def to_s
  to_hash.to_s
end