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

UPGRADE_SCHEDULE_ENUM =
[
  UPGRADE_SCHEDULE_UPGRADE_IMMEDIATELY = 'UPGRADE_IMMEDIATELY'.freeze,
  UPGRADE_SCHEDULE_DELAYED_UPGRADE = 'DELAYED_UPGRADE'.freeze,
  UPGRADE_SCHEDULE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
INSTANCE_USAGE_TYPE_ENUM =
[
  INSTANCE_USAGE_TYPE_PRIMARY = 'PRIMARY'.freeze,
  INSTANCE_USAGE_TYPE_NONPRIMARY = 'NONPRIMARY'.freeze,
  INSTANCE_USAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
INSTANCE_ACCESS_TYPE_ENUM =
[
  INSTANCE_ACCESS_TYPE_PUBLIC = 'PUBLIC'.freeze,
  INSTANCE_ACCESS_TYPE_PRIVATE = 'PRIVATE'.freeze,
  INSTANCE_ACCESS_TYPE_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_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

  • :upgrade_schedule (String)

    The value to assign to the #upgrade_schedule property

  • :identity_stripe (OCI::Oce::Models::IdentityStripeDetails)

    The value to assign to the #identity_stripe property

  • :instance_usage_type (String)

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

  • :waf_primary_domain (String)

    The value to assign to the #waf_primary_domain property

  • :instance_access_type (String)

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



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/oci/oce/models/oce_instance.rb', line 222

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

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

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

  self.identity_stripe = attributes[:'identityStripe'] if attributes[:'identityStripe']

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

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

  self.instance_usage_type = attributes[:'instanceUsageType'] if attributes[:'instanceUsageType']

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

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

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

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

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

  self.instance_access_type = attributes[:'instanceAccessType'] if attributes[:'instanceAccessType']

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

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

  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_emailString

[Required] Admin Email for Notification

Returns:

  • (String)


90
91
92
# File 'lib/oci/oce/models/oce_instance.rb', line 90

def admin_email
  @admin_email
end

#compartment_idString

[Required] Compartment Identifier

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

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


126
127
128
# File 'lib/oci/oce/models/oce_instance.rb', line 126

def defined_tags
  @defined_tags
end

#descriptionString

OceInstance description, can be updated

Returns:

  • (String)


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

def description
  @description
end

#freeform_tagsHash<String, String>

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

Returns:

  • (Hash<String, String>)


120
121
122
# File 'lib/oci/oce/models/oce_instance.rb', line 120

def freeform_tags
  @freeform_tags
end

#guidString

[Required] Unique GUID identifier that is immutable on creation

Returns:

  • (String)


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

def guid
  @guid
end

#idString

[Required] Unique identifier that is immutable on creation

Returns:

  • (String)


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

def id
  @id
end

#idcs_tenancyString

[Required] IDCS Tenancy Identifier

Returns:

  • (String)


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

def idcs_tenancy
  @idcs_tenancy
end

#identity_stripeOCI::Oce::Models::IdentityStripeDetails



78
79
80
# File 'lib/oci/oce/models/oce_instance.rb', line 78

def identity_stripe
  @identity_stripe
end

#instance_access_typeString

Flag indicating whether the instance access is private or public

Returns:

  • (String)


98
99
100
# File 'lib/oci/oce/models/oce_instance.rb', line 98

def instance_access_type
  @instance_access_type
end

#instance_usage_typeString

Instance type based on its usage

Returns:

  • (String)


82
83
84
# File 'lib/oci/oce/models/oce_instance.rb', line 82

def instance_usage_type
  @instance_usage_type
end

#lifecycle_stateString

The current state of the file system.

Returns:

  • (String)


110
111
112
# File 'lib/oci/oce/models/oce_instance.rb', line 110

def lifecycle_state
  @lifecycle_state
end

#nameString

[Required] OceInstance Name

Returns:

  • (String)


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

def name
  @name
end

#object_storage_namespaceString

[Required] Object Storage Namespace of tenancy

Returns:

  • (String)


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

def object_storage_namespace
  @object_storage_namespace
end

#serviceHash<String, Object>

SERVICE data. Example: {\"service\": {\"IDCS\": \"value\"}}

Returns:

  • (Hash<String, Object>)


132
133
134
# File 'lib/oci/oce/models/oce_instance.rb', line 132

def service
  @service
end

#state_messageString

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)


114
115
116
# File 'lib/oci/oce/models/oce_instance.rb', line 114

def state_message
  @state_message
end

#tenancy_idString

[Required] Tenancy Identifier

Returns:

  • (String)


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

def tenancy_id
  @tenancy_id
end

#tenancy_nameString

[Required] Tenancy Name

Returns:

  • (String)


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

def tenancy_name
  @tenancy_name
end

#time_createdDateTime

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

Returns:

  • (DateTime)


102
103
104
# File 'lib/oci/oce/models/oce_instance.rb', line 102

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


106
107
108
# File 'lib/oci/oce/models/oce_instance.rb', line 106

def time_updated
  @time_updated
end

#upgrade_scheduleString

Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

Returns:

  • (String)


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

def upgrade_schedule
  @upgrade_schedule
end

#waf_primary_domainString

Web Application Firewall(WAF) primary domain

Returns:

  • (String)


94
95
96
# File 'lib/oci/oce/models/oce_instance.rb', line 94

def waf_primary_domain
  @waf_primary_domain
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/oci/oce/models/oce_instance.rb', line 135

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',
    'upgrade_schedule': :'upgradeSchedule',
    'identity_stripe': :'identityStripe',
    'instance_usage_type': :'instanceUsageType',
    'object_storage_namespace': :'objectStorageNamespace',
    'admin_email': :'adminEmail',
    'waf_primary_domain': :'wafPrimaryDomain',
    'instance_access_type': :'instanceAccessType',
    '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_typesObject

Attribute type mapping.



165
166
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
# File 'lib/oci/oce/models/oce_instance.rb', line 165

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',
    'upgrade_schedule': :'String',
    'identity_stripe': :'OCI::Oce::Models::IdentityStripeDetails',
    'instance_usage_type': :'String',
    'object_storage_namespace': :'String',
    'admin_email': :'String',
    'waf_primary_domain': :'String',
    'instance_access_type': :'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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/oci/oce/models/oce_instance.rb', line 400

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 &&
    upgrade_schedule == other.upgrade_schedule &&
    identity_stripe == other.identity_stripe &&
    instance_usage_type == other.instance_usage_type &&
    object_storage_namespace == other.object_storage_namespace &&
    admin_email == other.admin_email &&
    waf_primary_domain == other.waf_primary_domain &&
    instance_access_type == other.instance_access_type &&
    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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
# File 'lib/oci/oce/models/oce_instance.rb', line 451

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


431
432
433
# File 'lib/oci/oce/models/oce_instance.rb', line 431

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



440
441
442
# File 'lib/oci/oce/models/oce_instance.rb', line 440

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



484
485
486
487
488
489
490
491
492
493
# File 'lib/oci/oce/models/oce_instance.rb', line 484

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



478
479
480
# File 'lib/oci/oce/models/oce_instance.rb', line 478

def to_s
  to_hash.to_s
end