Class: OCI::Identity::Models::Domain

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

Overview

(For tenancies that support identity domains) Properties for an identity domain. An identity domain is used to manage users and groups, integration standards, external identities, and secure application integration through Oracle Single Sign-on (SSO) configuration.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DEFAULT = 'DEFAULT'.freeze,
  TYPE_SECONDARY = 'SECONDARY'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_DEACTIVATING = 'DEACTIVATING'.freeze,
  LIFECYCLE_DETAILS_ACTIVATING = 'ACTIVATING'.freeze,
  LIFECYCLE_DETAILS_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Domain

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :url (String) —

    The value to assign to the #url property

  • :home_region_url (String) —

    The value to assign to the #home_region_url property

  • :home_region (String) —

    The value to assign to the #home_region property

  • :replica_regions (Array<OCI::Identity::Models::ReplicatedRegionDetails>) —

    The value to assign to the #replica_regions property

  • :type (String) —

    The value to assign to the #type property

  • :license_type (String) —

    The value to assign to the #license_type property

  • :is_hidden_on_login (BOOLEAN) —

    The value to assign to the #is_hidden_on_login property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/identity/models/domain.rb', line 186

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

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

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

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

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

  self.home_region_url = attributes[:'homeRegionUrl'] if attributes[:'homeRegionUrl']

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

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

  self.home_region = attributes[:'homeRegion'] if attributes[:'homeRegion']

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

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

  self.replica_regions = attributes[:'replicaRegions'] if attributes[:'replicaRegions']

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

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

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

  self.license_type = attributes[:'licenseType'] if attributes[:'licenseType']

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

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

  self. = attributes[:'isHiddenOnLogin'] unless attributes[:'isHiddenOnLogin'].nil?

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

  self. = attributes[:'is_hidden_on_login'] unless attributes[:'is_hidden_on_login'].nil?

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

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

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

  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 the compartment containing the identity domain.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/identity/models/domain.rb', line 40

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


114
115
116
 
# File 'lib/oci/identity/models/domain.rb', line 114

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The identity domain description. You can have an empty description.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/identity/models/domain.rb', line 48

def description
  @description
end

#display_name ⇒ String

[Required] The mutable display name of the identity domain.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/identity/models/domain.rb', line 44

def display_name
  @display_name
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>) 


107
108
109
 
# File 'lib/oci/identity/models/domain.rb', line 107

def freeform_tags
  @freeform_tags
end

#home_region ⇒ String

[Required] The home region for the identity domain. See Regions and Availability Domains for the full list of supported region names.

Example: us-phoenix-1

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/identity/models/domain.rb', line 65

def home_region
  @home_region
end

#home_region_url ⇒ String

[Required] Region-specific identity domain URL.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/identity/models/domain.rb', line 56

def home_region_url
  @home_region_url
end

#id ⇒ String

[Required] The OCID of the identity domain.

Returns:

  • (String) 


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

def id
  @id
end

#is_hidden_on_login ⇒ BOOLEAN

[Required] Indicates whether the identity domain is hidden on the sign-in screen or not.

Returns:

  • (BOOLEAN) 


83
84
85
 
# File 'lib/oci/identity/models/domain.rb', line 83

def 
  @is_hidden_on_login
end

#license_type ⇒ String

[Required] The license type of the identity domain.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/identity/models/domain.rb', line 78

def license_type
  @license_type
end

#lifecycle_details ⇒ String

Any additional details about the current state of the identity domain.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/identity/models/domain.rb', line 100

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/identity/models/domain.rb', line 95

def lifecycle_state
  @lifecycle_state
end

#replica_regions ⇒ Array<OCI::Identity::Models::ReplicatedRegionDetails>

[Required] The regions where replicas of the identity domain exist.

Returns:



69
70
71
 
# File 'lib/oci/identity/models/domain.rb', line 69

def replica_regions
  @replica_regions
end

#time_created ⇒ DateTime

[Required] Date and time the identity domain was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/identity/models/domain.rb', line 90

def time_created
  @time_created
end

#type ⇒ String

[Required] The type of the domain.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/identity/models/domain.rb', line 74

def type
  @type
end

#url ⇒ String

[Required] Region-agnostic identity domain URL.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/identity/models/domain.rb', line 52

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/identity/models/domain.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'url': :'url',
    'home_region_url': :'homeRegionUrl',
    'home_region': :'homeRegion',
    'replica_regions': :'replicaRegions',
    'type': :'type',
    'license_type': :'licenseType',
    'is_hidden_on_login': :'isHiddenOnLogin',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/domain.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'url': :'String',
    'home_region_url': :'String',
    'home_region': :'String',
    'replica_regions': :'Array<OCI::Identity::Models::ReplicatedRegionDetails>',
    'type': :'String',
    'license_type': :'String',
    'is_hidden_on_login': :'BOOLEAN',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/identity/models/domain.rb', line 319

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    url == other.url &&
    home_region_url == other.home_region_url &&
    home_region == other.home_region &&
    replica_regions == other.replica_regions &&
    type == other.type &&
    license_type == other.license_type &&
     == other. &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/oci/identity/models/domain.rb', line 364

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


344
345
346
 
# File 'lib/oci/identity/models/domain.rb', line 344

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



353
354
355
 
# File 'lib/oci/identity/models/domain.rb', line 353

def hash
  [id, compartment_id, display_name, description, url, home_region_url, home_region, replica_regions, type, license_type, , time_created, lifecycle_state, lifecycle_details, 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



397
398
399
400
401
402
403
404
405
406
 
# File 'lib/oci/identity/models/domain.rb', line 397

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



391
392
393
 
# File 'lib/oci/identity/models/domain.rb', line 391

def to_s
  to_hash.to_s
end