Class: OCI::Oce::Models::OceInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oce/models/oce_instance.rb

Overview

Details of OceInstance.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ OceInstance

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

  • :guid (String) —

    The value to assign to the #guid property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :idcs_tenancy (String) —

    The value to assign to the #idcs_tenancy property

  • :tenancy_name (String) —

    The value to assign to the #tenancy_name property

  • :object_storage_namespace (String) —

    The value to assign to the #object_storage_namespace property

  • :admin_email (String) —

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

  • :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

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

    The value to assign to the #service property



167
168
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
251
252
253
254
 
# File 'lib/oci/oce/models/oce_instance.rb', line 167

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

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

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

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

  self.idcs_tenancy = attributes[:'idcsTenancy'] if attributes[:'idcsTenancy']

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

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

  self.tenancy_name = attributes[:'tenancyName'] if attributes[:'tenancyName']

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

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

  self.object_storage_namespace = attributes[:'objectStorageNamespace'] if attributes[:'objectStorageNamespace']

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

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

  self.admin_email = attributes[:'adminEmail'] if attributes[:'adminEmail']

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

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

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

Instance Attribute Details

#admin_email ⇒ String

[Required] Admin Email for Notification

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/oce/models/oce_instance.rb', line 58

def admin_email
  @admin_email
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/oce/models/oce_instance.rb', line 34

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: ‘{"bar-key": "value"}`

Returns:

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


86
87
88
 
# File 'lib/oci/oce/models/oce_instance.rb', line 86

def defined_tags
  @defined_tags
end

#description ⇒ String

OceInstance description, can be updated

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/oce/models/oce_instance.rb', line 30

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: ‘"value"`

Returns:

  • (Hash<String, String>) 


80
81
82
 
# File 'lib/oci/oce/models/oce_instance.rb', line 80

def freeform_tags
  @freeform_tags
end

#guid ⇒ String

[Required] Unique GUID identifier that is immutable on creation

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/oce/models/oce_instance.rb', line 26

def guid
  @guid
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/oce/models/oce_instance.rb', line 22

def id
  @id
end

#idcs_tenancy ⇒ String

[Required] IDCS Tenancy Identifier

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/oce/models/oce_instance.rb', line 46

def idcs_tenancy
  @idcs_tenancy
end

#lifecycle_state ⇒ String

The current state of the file system.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/oce/models/oce_instance.rb', line 70

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] OceInstance Name

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/oce/models/oce_instance.rb', line 38

def name
  @name
end

#object_storage_namespace ⇒ String

[Required] Object Storage Namespace of tenancy

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/oce/models/oce_instance.rb', line 54

def object_storage_namespace
  @object_storage_namespace
end

#service ⇒ Hash<String, Object>

SERVICE data. Example: ‘{"IDCS": "value"}`

Returns:

  • (Hash<String, Object>) 


92
93
94
 
# File 'lib/oci/oce/models/oce_instance.rb', line 92

def service
  @service
end

#state_message ⇒ String

An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/oce/models/oce_instance.rb', line 74

def state_message
  @state_message
end

#tenancy_id ⇒ String

[Required] Tenancy Identifier

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/oce/models/oce_instance.rb', line 42

def tenancy_id
  @tenancy_id
end

#tenancy_name ⇒ String

[Required] Tenancy Name

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/oce/models/oce_instance.rb', line 50

def tenancy_name
  @tenancy_name
end

#time_created ⇒ DateTime

The time the the OceInstance was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/oce/models/oce_instance.rb', line 62

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the OceInstance was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/oce/models/oce_instance.rb', line 66

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/oce/models/oce_instance.rb', line 95

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'guid': :'guid',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'tenancy_id': :'tenancyId',
    'idcs_tenancy': :'idcsTenancy',
    'tenancy_name': :'tenancyName',
    'object_storage_namespace': :'objectStorageNamespace',
    'admin_email': :'adminEmail',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'state_message': :'stateMessage',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'service': :'service'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/oce/models/oce_instance.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'guid': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'tenancy_id': :'String',
    'idcs_tenancy': :'String',
    'tenancy_name': :'String',
    'object_storage_namespace': :'String',
    'admin_email': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'state_message': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'service': :'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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/oce/models/oce_instance.rb', line 276

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

  self.class == other.class &&
    id == other.id &&
    guid == other.guid &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    tenancy_id == other.tenancy_id &&
    idcs_tenancy == other.idcs_tenancy &&
    tenancy_name == other.tenancy_name &&
    object_storage_namespace == other.object_storage_namespace &&
    admin_email == other.admin_email &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    state_message == other.state_message &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    service == other.service
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/oce/models/oce_instance.rb', line 322

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


302
303
304
 
# File 'lib/oci/oce/models/oce_instance.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/oce/models/oce_instance.rb', line 311

def hash
  [id, guid, description, compartment_id, name, tenancy_id, idcs_tenancy, tenancy_name, object_storage_namespace, admin_email, time_created, time_updated, lifecycle_state, state_message, freeform_tags, defined_tags, service].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/oce/models/oce_instance.rb', line 355

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



349
350
351
 
# File 'lib/oci/oce/models/oce_instance.rb', line 349

def to_s
  to_hash.to_s
end