Class: OCI::Oda::Models::OdaInstanceSummary

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

Overview

Summary of the Digital Assistant instance.

Constant Summary collapse

SHAPE_NAME_ENUM = 
[
  SHAPE_NAME_DEVELOPMENT = 'DEVELOPMENT'.freeze,
  SHAPE_NAME_PRODUCTION = 'PRODUCTION'.freeze,
  SHAPE_NAME_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
LIFECYCLE_SUB_STATE_ENUM = 
[
  LIFECYCLE_SUB_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_SUB_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_SUB_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_SUB_STATE_CHANGING_COMPARTMENT = 'CHANGING_COMPARTMENT'.freeze,
  LIFECYCLE_SUB_STATE_ACTIVATING_CUSTOMER_ENCRYPTION_KEY = 'ACTIVATING_CUSTOMER_ENCRYPTION_KEY'.freeze,
  LIFECYCLE_SUB_STATE_UPDATING_CUSTOMER_ENCRYPTION_KEY = 'UPDATING_CUSTOMER_ENCRYPTION_KEY'.freeze,
  LIFECYCLE_SUB_STATE_DEACTIVATING_CUSTOMER_ENCRYPTION_KEY = 'DEACTIVATING_CUSTOMER_ENCRYPTION_KEY'.freeze,
  LIFECYCLE_SUB_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_SUB_STATE_DELETE_PENDING = 'DELETE_PENDING'.freeze,
  LIFECYCLE_SUB_STATE_RECOVERING = 'RECOVERING'.freeze,
  LIFECYCLE_SUB_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_SUB_STATE_PURGING = 'PURGING'.freeze,
  LIFECYCLE_SUB_STATE_QUEUED = 'QUEUED'.freeze,
  LIFECYCLE_SUB_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 = {}) ⇒ OdaInstanceSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :shape_name (String) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_sub_state (String) —

    The value to assign to the #lifecycle_sub_state property

  • :state_message (String) —

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

  • :is_role_based_access (BOOLEAN) —

    The value to assign to the #is_role_based_access property

  • :identity_domain (String) —

    The value to assign to the #identity_domain property

  • :imported_package_names (Array<String>) —

    The value to assign to the #imported_package_names property

  • :attachment_types (Array<String>) —

    The value to assign to the #attachment_types 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
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/oda/models/oda_instance_summary.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.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.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.shape_name = attributes[:'shapeName'] if attributes[:'shapeName']

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

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

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

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

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

  self.state_message = attributes[:'stateMessage'] if attributes[:'stateMessage']

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

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

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

  self.is_role_based_access = attributes[:'isRoleBasedAccess'] unless attributes[:'isRoleBasedAccess'].nil?
  self.is_role_based_access = false if is_role_based_access.nil? && !attributes.key?(:'isRoleBasedAccess') # rubocop:disable Style/StringLiterals

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

  self.is_role_based_access = attributes[:'is_role_based_access'] unless attributes[:'is_role_based_access'].nil?
  self.is_role_based_access = false if is_role_based_access.nil? && !attributes.key?(:'isRoleBasedAccess') && !attributes.key?(:'is_role_based_access') # rubocop:disable Style/StringLiterals

  self.identity_domain = attributes[:'identityDomain'] if attributes[:'identityDomain']

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

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

  self.imported_package_names = attributes[:'importedPackageNames'] if attributes[:'importedPackageNames']

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

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

  self.attachment_types = attributes[:'attachmentTypes'] if attributes[:'attachmentTypes']

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

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

Instance Attribute Details

#attachment_types ⇒ Array<String>

A list of attachment types for this instance (if any).

Returns:

  • (Array<String>) 


114
115
116
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 114

def attachment_types
  @attachment_types
end

#compartment_id ⇒ String

[Required] Identifier of the compartment that the instance belongs to.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 60

def compartment_id
  @compartment_id
end

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


98
99
100
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 98

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the Digital Assistant instance.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 56

def description
  @description
end

#display_name ⇒ String

User-defined name for the Digital Assistant instance. You can change this value.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 52

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


92
93
94
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 92

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier of the Digital Assistant instance.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 48

def id
  @id
end

#identity_domain ⇒ String

If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 106

def identity_domain
  @identity_domain
end

#imported_package_names ⇒ Array<String>

A list of package names imported into this instance (if any).

Returns:

  • (Array<String>) 


110
111
112
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 110

def imported_package_names
  @imported_package_names
end

#is_role_based_access ⇒ BOOLEAN

Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)

Returns:

  • (BOOLEAN) 


102
103
104
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 102

def is_role_based_access
  @is_role_based_access
end

#lifecycle_state ⇒ String

[Required] The current state of the instance.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

The current sub-state of the Digital Assistant instance.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 80

def lifecycle_sub_state
  @lifecycle_sub_state
end

#shape_name ⇒ String

Shape or size of the instance.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 64

def shape_name
  @shape_name
end

#state_message ⇒ String

A message describing the current state in more detail. For example, actionable information about an instance that's in the FAILED state.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 86

def state_message
  @state_message
end

#time_created ⇒ DateTime

When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 68

def time_created
  @time_created
end

#time_updated ⇒ DateTime

When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 72

def time_updated
  @time_updated
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/oda/models/oda_instance_summary.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'shape_name': :'shapeName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_sub_state': :'lifecycleSubState',
    'state_message': :'stateMessage',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'is_role_based_access': :'isRoleBasedAccess',
    'identity_domain': :'identityDomain',
    'imported_package_names': :'importedPackageNames',
    'attachment_types': :'attachmentTypes'
    # 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/oda/models/oda_instance_summary.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'shape_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_sub_state': :'String',
    'state_message': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'is_role_based_access': :'BOOLEAN',
    'identity_domain': :'String',
    'imported_package_names': :'Array<String>',
    'attachment_types': :'Array<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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 329

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    shape_name == other.shape_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_sub_state == other.lifecycle_sub_state &&
    state_message == other.state_message &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    is_role_based_access == other.is_role_based_access &&
    identity_domain == other.identity_domain &&
    imported_package_names == other.imported_package_names &&
    attachment_types == other.attachment_types
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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 374

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


354
355
356
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 354

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 363

def hash
  [id, display_name, description, compartment_id, shape_name, time_created, time_updated, lifecycle_state, lifecycle_sub_state, state_message, freeform_tags, defined_tags, is_role_based_access, identity_domain, imported_package_names, attachment_types].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 407

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



401
402
403
 
# File 'lib/oci/oda/models/oda_instance_summary.rb', line 401

def to_s
  to_hash.to_s
end