Class: OCI::VisualBuilder::Models::VbInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/visual_builder/models/vb_instance.rb

Overview

Description of Vb Instance.

Constant Summary collapse

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
CONSUMPTION_MODEL_ENUM = 
[
  CONSUMPTION_MODEL_UCM = 'UCM'.freeze,
  CONSUMPTION_MODEL_GOV = 'GOV'.freeze,
  CONSUMPTION_MODEL_VB4_SAAS = 'VB4SAAS'.freeze,
  CONSUMPTION_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VbInstance

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 204

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

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

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

  self.instance_url = attributes[:'instanceUrl'] if attributes[:'instanceUrl']

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

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

  self.node_count = attributes[:'nodeCount'] if attributes[:'nodeCount']

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

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

  self.is_visual_builder_enabled = attributes[:'isVisualBuilderEnabled'] unless attributes[:'isVisualBuilderEnabled'].nil?

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

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

  self.custom_endpoint = attributes[:'customEndpoint'] if attributes[:'customEndpoint']

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

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

  self.alternate_custom_endpoints = attributes[:'alternateCustomEndpoints'] if attributes[:'alternateCustomEndpoints']

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

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

  self.consumption_model = attributes[:'consumptionModel'] if attributes[:'consumptionModel']

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

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

  self.service_nat_gateway_ip = attributes[:'serviceNatGatewayIp'] if attributes[:'serviceNatGatewayIp']

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

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

  self.management_nat_gateway_ip = attributes[:'managementNatGatewayIp'] if attributes[:'managementNatGatewayIp']

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

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

  self.service_vcn_id = attributes[:'serviceVcnId'] if attributes[:'serviceVcnId']

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

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

  self.management_vcn_id = attributes[:'managementVcnId'] if attributes[:'managementVcnId']

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

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

  self.network_endpoint_details = attributes[:'networkEndpointDetails'] if attributes[:'networkEndpointDetails']

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

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

Instance Attribute Details

#alternate_custom_endpoints ⇒ Array<OCI::VisualBuilder::Models::CustomEndpointDetails>

A list of alternate custom endpoints used for the vb instance URL.

Returns:



94
95
96
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 94

def alternate_custom_endpoints
  @alternate_custom_endpoints
end

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 40

def compartment_id
  @compartment_id
end

#consumption_model ⇒ String

The entitlement used for billing purposes.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 98

def consumption_model
  @consumption_model
end

#custom_endpoint ⇒ OCI::VisualBuilder::Models::CustomEndpointDetails

Returns:



89
90
91
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 89

def custom_endpoint
  @custom_endpoint
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


68
69
70
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 68

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Vb Instance Identifier, can be renamed.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 36

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. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


62
63
64
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 62

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 32

def id
  @id
end

#instance_url ⇒ String

[Required] The Vb Instance URL.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 78

def instance_url
  @instance_url
end

#is_visual_builder_enabled ⇒ BOOLEAN

Visual Builder is enabled or not.

Returns:

  • (BOOLEAN) 


86
87
88
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 86

def is_visual_builder_enabled
  @is_visual_builder_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the vb instance.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 52

def lifecycle_state
  @lifecycle_state
end

#management_nat_gateway_ip ⇒ String

The NAT gateway IP address for the VB management VCN

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 106

def management_nat_gateway_ip
  @management_nat_gateway_ip
end

#management_vcn_id ⇒ String

The Oracle Cloud ID (OCID) of the Visual Builder management VCN

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 114

def management_vcn_id
  @management_vcn_id
end

#network_endpoint_details ⇒ OCI::VisualBuilder::Models::NetworkEndpointDetails

Returns:



117
118
119
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 117

def network_endpoint_details
  @network_endpoint_details
end

#node_count ⇒ Integer

[Required] The number of Nodes

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 82

def node_count
  @node_count
end

#service_nat_gateway_ip ⇒ String

The NAT gateway IP address for the VB service VCN

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 102

def service_nat_gateway_ip
  @service_nat_gateway_ip
end

#service_vcn_id ⇒ String

The Oracle Cloud ID (OCID) of the Visual Builder service VCN

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 110

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


56
57
58
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 56

def state_message
  @state_message
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


74
75
76
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 74

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 44

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 48

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'state_message': :'stateMessage',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'instance_url': :'instanceUrl',
    'node_count': :'nodeCount',
    'is_visual_builder_enabled': :'isVisualBuilderEnabled',
    'custom_endpoint': :'customEndpoint',
    'alternate_custom_endpoints': :'alternateCustomEndpoints',
    'consumption_model': :'consumptionModel',
    'service_nat_gateway_ip': :'serviceNatGatewayIp',
    'management_nat_gateway_ip': :'managementNatGatewayIp',
    'service_vcn_id': :'serviceVcnId',
    'management_vcn_id': :'managementVcnId',
    'network_endpoint_details': :'networkEndpointDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 149

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'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>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'instance_url': :'String',
    'node_count': :'Integer',
    'is_visual_builder_enabled': :'BOOLEAN',
    'custom_endpoint': :'OCI::VisualBuilder::Models::CustomEndpointDetails',
    'alternate_custom_endpoints': :'Array<OCI::VisualBuilder::Models::CustomEndpointDetails>',
    'consumption_model': :'String',
    'service_nat_gateway_ip': :'String',
    'management_nat_gateway_ip': :'String',
    'service_vcn_id': :'String',
    'management_vcn_id': :'String',
    'network_endpoint_details': :'OCI::VisualBuilder::Models::NetworkEndpointDetails'
    # 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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 366

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    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 &&
    system_tags == other.system_tags &&
    instance_url == other.instance_url &&
    node_count == other.node_count &&
    is_visual_builder_enabled == other.is_visual_builder_enabled &&
    custom_endpoint == other.custom_endpoint &&
    alternate_custom_endpoints == other.alternate_custom_endpoints &&
    consumption_model == other.consumption_model &&
    service_nat_gateway_ip == other.service_nat_gateway_ip &&
    management_nat_gateway_ip == other.management_nat_gateway_ip &&
    service_vcn_id == other.service_vcn_id &&
    management_vcn_id == other.management_vcn_id &&
    network_endpoint_details == other.network_endpoint_details
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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 416

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


396
397
398
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 396

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



405
406
407
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 405

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_state, state_message, freeform_tags, defined_tags, system_tags, instance_url, node_count, is_visual_builder_enabled, custom_endpoint, alternate_custom_endpoints, consumption_model, service_nat_gateway_ip, management_nat_gateway_ip, service_vcn_id, management_vcn_id, network_endpoint_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



449
450
451
452
453
454
455
456
457
458
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 449

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



443
444
445
 
# File 'lib/oci/visual_builder/models/vb_instance.rb', line 443

def to_s
  to_hash.to_s
end