Class: OCI::Oda::Models::OdaInstance

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

Overview

Description of OdaServiceInstance object.

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_DELETING = 'DELETING'.freeze,
  LIFECYCLE_SUB_STATE_DELETE_PENDING = 'DELETE_PENDING'.freeze,
  LIFECYCLE_SUB_STATE_RECOVERING = 'RECOVERING'.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 = {}) ⇒ OdaInstance

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

  • :web_app_url (String) —

    The value to assign to the #web_app_url property

  • :connector_url (String) —

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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
 
# File 'lib/oci/oda/models/oda_instance.rb', line 169

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

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

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

  self.connector_url = attributes[:'connectorUrl'] if attributes[:'connectorUrl']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/oda/models/oda_instance.rb', line 57

def compartment_id
  @compartment_id
end

#connector_url ⇒ String

URL for the connector's endpoint.

Returns:

  • (String) 


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

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


103
104
105
 
# File 'lib/oci/oda/models/oda_instance.rb', line 103

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the Digital Assistant instance.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/oda/models/oda_instance.rb', line 53

def description
  @description
end

#display_name ⇒ String

User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/oda/models/oda_instance.rb', line 49

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


97
98
99
 
# File 'lib/oci/oda/models/oda_instance.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the Digital Assistant instance.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/oda/models/oda_instance.rb', line 81

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

The current sub-state of the Digital Assistant instance.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/oda/models/oda_instance.rb', line 85

def lifecycle_sub_state
  @lifecycle_sub_state
end

#shape_name ⇒ String

[Required] Shape or size of the instance.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/oda/models/oda_instance.rb', line 61

def shape_name
  @shape_name
end

#state_message ⇒ String

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

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/oda/models/oda_instance.rb', line 91

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) 


73
74
75
 
# File 'lib/oci/oda/models/oda_instance.rb', line 73

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/oda/models/oda_instance.rb', line 77

def time_updated
  @time_updated
end

#web_app_url ⇒ String

URL for the Digital Assistant web application that's associated with the instance.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/oda/models/oda_instance.rb', line 65

def web_app_url
  @web_app_url
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/oda/models/oda_instance.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'shape_name': :'shapeName',
    'web_app_url': :'webAppUrl',
    'connector_url': :'connectorUrl',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_sub_state': :'lifecycleSubState',
    'state_message': :'stateMessage',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/oda/models/oda_instance.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'shape_name': :'String',
    'web_app_url': :'String',
    'connector_url': :'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>>'
    # 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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/oda/models/oda_instance.rb', line 298

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 &&
    web_app_url == other.web_app_url &&
    connector_url == other.connector_url &&
    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
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/oda/models/oda_instance.rb', line 341

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


321
322
323
 
# File 'lib/oci/oda/models/oda_instance.rb', line 321

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



330
331
332
 
# File 'lib/oci/oda/models/oda_instance.rb', line 330

def hash
  [id, display_name, description, compartment_id, shape_name, web_app_url, connector_url, time_created, time_updated, lifecycle_state, lifecycle_sub_state, state_message, 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



374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/oda/models/oda_instance.rb', line 374

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



368
369
370
 
# File 'lib/oci/oda/models/oda_instance.rb', line 368

def to_s
  to_hash.to_s
end