Class: OCI::GoldenGate::Models::DeploymentSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/deployment_summary.rb

Overview

Summary of the Deployment.

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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_SUB_STATE_ENUM = 
[
  LIFECYCLE_SUB_STATE_RECOVERING = 'RECOVERING'.freeze,
  LIFECYCLE_SUB_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_SUB_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_SUB_STATE_MOVING = 'MOVING'.freeze,
  LIFECYCLE_SUB_STATE_UPGRADING = 'UPGRADING'.freeze,
  LIFECYCLE_SUB_STATE_RESTORING = 'RESTORING'.freeze,
  LIFECYCLE_SUB_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'.freeze,
  LIFECYCLE_SUB_STATE_ROLLBACK_IN_PROGRESS = 'ROLLBACK_IN_PROGRESS'.freeze,
  LIFECYCLE_SUB_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LICENSE_MODEL_ENUM = 
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze,
  LICENSE_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ENVIRONMENT_TYPE_ENUM = 
[
  ENVIRONMENT_TYPE_PRODUCTION = 'PRODUCTION'.freeze,
  ENVIRONMENT_TYPE_DEVELOPMENT_OR_TESTING = 'DEVELOPMENT_OR_TESTING'.freeze,
  ENVIRONMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CATEGORY_ENUM = 
[
  CATEGORY_DATA_REPLICATION = 'DATA_REPLICATION'.freeze,
  CATEGORY_STREAM_ANALYTICS = 'STREAM_ANALYTICS'.freeze,
  CATEGORY_DATA_TRANSFORMS = 'DATA_TRANSFORMS'.freeze,
  CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DEPLOYMENT_TYPE_ENUM = 
[
  DEPLOYMENT_TYPE_OGG = 'OGG'.freeze,
  DEPLOYMENT_TYPE_DATABASE_ORACLE = 'DATABASE_ORACLE'.freeze,
  DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'.freeze,
  DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER = 'DATABASE_MICROSOFT_SQLSERVER'.freeze,
  DEPLOYMENT_TYPE_DATABASE_MYSQL = 'DATABASE_MYSQL'.freeze,
  DEPLOYMENT_TYPE_DATABASE_POSTGRESQL = 'DATABASE_POSTGRESQL'.freeze,
  DEPLOYMENT_TYPE_DATABASE_DB2_ZOS = 'DATABASE_DB2ZOS'.freeze,
  DEPLOYMENT_TYPE_GGSA = 'GGSA'.freeze,
  DEPLOYMENT_TYPE_DATA_TRANSFORMS = 'DATA_TRANSFORMS'.freeze,
  DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeploymentSummary

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

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

  • :lifecycle_details (String) —

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

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :load_balancer_subnet_id (String) —

    The value to assign to the #load_balancer_subnet_id property

  • :load_balancer_id (String) —

    The value to assign to the #load_balancer_id property

  • :license_model (String) —

    The value to assign to the #license_model property

  • :environment_type (String) —

    The value to assign to the #environment_type property

  • :category (String) —

    The value to assign to the #category property

  • :fqdn (String) —

    The value to assign to the #fqdn property

  • :cpu_core_count (Integer) —

    The value to assign to the #cpu_core_count property

  • :is_auto_scaling_enabled (BOOLEAN) —

    The value to assign to the #is_auto_scaling_enabled property

  • :is_public (BOOLEAN) —

    The value to assign to the #is_public property

  • :public_ip_address (String) —

    The value to assign to the #public_ip_address property

  • :private_ip_address (String) —

    The value to assign to the #private_ip_address property

  • :deployment_url (String) —

    The value to assign to the #deployment_url property

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

    The value to assign to the #system_tags property

  • :is_latest_version (BOOLEAN) —

    The value to assign to the #is_latest_version property

  • :time_upgrade_required (DateTime) —

    The value to assign to the #time_upgrade_required property

  • :deployment_type (String) —

    The value to assign to the #deployment_type property

  • :storage_utilization_in_bytes (Integer) —

    The value to assign to the #storage_utilization_in_bytes property

  • :is_storage_utilization_limit_exceeded (BOOLEAN) —

    The value to assign to the #is_storage_utilization_limit_exceeded property

  • :locks (Array<OCI::GoldenGate::Models::ResourceLock>) —

    The value to assign to the #locks property



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 371

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

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

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

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

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

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

  self.load_balancer_subnet_id = attributes[:'loadBalancerSubnetId'] if attributes[:'loadBalancerSubnetId']

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

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

  self.load_balancer_id = attributes[:'loadBalancerId'] if attributes[:'loadBalancerId']

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

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

  self.license_model = attributes[:'licenseModel'] if attributes[:'licenseModel']

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

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

  self.environment_type = attributes[:'environmentType'] if attributes[:'environmentType']

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

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

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

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

  self.cpu_core_count = attributes[:'cpuCoreCount'] if attributes[:'cpuCoreCount']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

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

  self.is_public = attributes[:'isPublic'] unless attributes[:'isPublic'].nil?

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

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

  self.public_ip_address = attributes[:'publicIpAddress'] if attributes[:'publicIpAddress']

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

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

  self.private_ip_address = attributes[:'privateIpAddress'] if attributes[:'privateIpAddress']

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

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

  self.deployment_url = attributes[:'deploymentUrl'] if attributes[:'deploymentUrl']

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

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

  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.is_latest_version = attributes[:'isLatestVersion'] unless attributes[:'isLatestVersion'].nil?

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

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

  self.time_upgrade_required = attributes[:'timeUpgradeRequired'] if attributes[:'timeUpgradeRequired']

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

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

  self.deployment_type = attributes[:'deploymentType'] if attributes[:'deploymentType']

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

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

  self.storage_utilization_in_bytes = attributes[:'storageUtilizationInBytes'] if attributes[:'storageUtilizationInBytes']

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

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

  self.is_storage_utilization_limit_exceeded = attributes[:'isStorageUtilizationLimitExceeded'] unless attributes[:'isStorageUtilizationLimitExceeded'].nil?

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

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

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

Instance Attribute Details

#category ⇒ String

[Required] The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.

Returns:

  • (String) 


171
172
173
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 171

def category
  @category
end

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 92

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

The Minimum number of OCPUs to be made available for this Deployment.

Returns:

  • (Integer) 


181
182
183
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 181

def cpu_core_count
  @cpu_core_count
end

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

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


135
136
137
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 135

def defined_tags
  @defined_tags
end

#deployment_type ⇒ String

[Required] The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.

Returns:

  • (String) 


239
240
241
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 239

def deployment_type
  @deployment_type
end

#deployment_url ⇒ String

The URL of a resource.

Returns:

  • (String) 


207
208
209
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 207

def deployment_url
  @deployment_url
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 87

def description
  @description
end

#display_name ⇒ String

An object's Display Name.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 82

def display_name
  @display_name
end

#environment_type ⇒ String

Specifies whether the deployment is used in a production or development/testing environment.

Returns:

  • (String) 


165
166
167
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 165

def environment_type
  @environment_type
end

#fqdn ⇒ String

A three-label Fully Qualified Domain Name (FQDN) for a resource.

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 176

def fqdn
  @fqdn
end

#freeform_tags ⇒ Hash<String, String>

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


128
129
130
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 128

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the deployment being referenced.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 77

def id
  @id
end

#is_auto_scaling_enabled ⇒ BOOLEAN

Indicates if auto scaling is enabled for the Deployment's CPU core count.

Returns:

  • (BOOLEAN) 


186
187
188
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 186

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_latest_version ⇒ BOOLEAN

Indicates if the resource is the the latest available version.

Returns:

  • (BOOLEAN) 


221
222
223
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 221

def is_latest_version
  @is_latest_version
end

#is_public ⇒ BOOLEAN

True if this object is publicly available.

Returns:

  • (BOOLEAN) 


191
192
193
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 191

def is_public
  @is_public
end

#is_storage_utilization_limit_exceeded ⇒ BOOLEAN

Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=. Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service.

Returns:

  • (BOOLEAN) 


250
251
252
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 250

def is_storage_utilization_limit_exceeded
  @is_storage_utilization_limit_exceeded
end

#license_model ⇒ String

[Required] The Oracle license model that applies to a Deployment.

Returns:

  • (String) 


160
161
162
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 160

def license_model
  @license_model
end

#lifecycle_details ⇒ String

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 120

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Possible lifecycle states.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 109

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

Possible GGS lifecycle sub-states.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 114

def lifecycle_sub_state
  @lifecycle_sub_state
end

#load_balancer_id ⇒ String

The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.

Returns:

  • (String) 


155
156
157
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 155

def load_balancer_id
  @load_balancer_id
end

#load_balancer_subnet_id ⇒ String

The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.

Returns:

  • (String) 


149
150
151
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 149

def load_balancer_subnet_id
  @load_balancer_subnet_id
end

#locks ⇒ Array<OCI::GoldenGate::Models::ResourceLock>

Locks associated with this resource.

Returns:



254
255
256
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 254

def locks
  @locks
end

#private_ip_address ⇒ String

The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.

Returns:

  • (String) 


202
203
204
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 202

def private_ip_address
  @private_ip_address
end

#public_ip_address ⇒ String

The public IP address representing the access point for the Deployment.

Returns:

  • (String) 


196
197
198
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 196

def public_ip_address
  @public_ip_address
end

#storage_utilization_in_bytes ⇒ Integer

The amount of storage being utilized (in bytes)

Returns:

  • (Integer) 


244
245
246
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 244

def storage_utilization_in_bytes
  @storage_utilization_in_bytes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.

Returns:

  • (String) 


142
143
144
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 142

def subnet_id
  @subnet_id
end

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

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


216
217
218
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 216

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 98

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 104

def time_updated
  @time_updated
end

#time_upgrade_required ⇒ DateTime

Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version. Old description: The date the existing version in use will no longer be considered as usable and an upgrade will be required. This date is typically 6 months after the version was released for use by GGS. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


232
233
234
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 232

def time_upgrade_required
  @time_upgrade_required
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 257

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_sub_state': :'lifecycleSubState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'subnet_id': :'subnetId',
    'load_balancer_subnet_id': :'loadBalancerSubnetId',
    'load_balancer_id': :'loadBalancerId',
    'license_model': :'licenseModel',
    'environment_type': :'environmentType',
    'category': :'category',
    'fqdn': :'fqdn',
    'cpu_core_count': :'cpuCoreCount',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'is_public': :'isPublic',
    'public_ip_address': :'publicIpAddress',
    'private_ip_address': :'privateIpAddress',
    'deployment_url': :'deploymentUrl',
    'system_tags': :'systemTags',
    'is_latest_version': :'isLatestVersion',
    'time_upgrade_required': :'timeUpgradeRequired',
    'deployment_type': :'deploymentType',
    'storage_utilization_in_bytes': :'storageUtilizationInBytes',
    'is_storage_utilization_limit_exceeded': :'isStorageUtilizationLimitExceeded',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 296

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_sub_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'subnet_id': :'String',
    'load_balancer_subnet_id': :'String',
    'load_balancer_id': :'String',
    'license_model': :'String',
    'environment_type': :'String',
    'category': :'String',
    'fqdn': :'String',
    'cpu_core_count': :'Integer',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'is_public': :'BOOLEAN',
    'public_ip_address': :'String',
    'private_ip_address': :'String',
    'deployment_url': :'String',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'is_latest_version': :'BOOLEAN',
    'time_upgrade_required': :'DateTime',
    'deployment_type': :'String',
    'storage_utilization_in_bytes': :'Integer',
    'is_storage_utilization_limit_exceeded': :'BOOLEAN',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>'
    # 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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 629

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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_sub_state == other.lifecycle_sub_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    subnet_id == other.subnet_id &&
    load_balancer_subnet_id == other.load_balancer_subnet_id &&
    load_balancer_id == other.load_balancer_id &&
    license_model == other.license_model &&
    environment_type == other.environment_type &&
    category == other.category &&
    fqdn == other.fqdn &&
    cpu_core_count == other.cpu_core_count &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    is_public == other.is_public &&
    public_ip_address == other.public_ip_address &&
    private_ip_address == other.private_ip_address &&
    deployment_url == other.deployment_url &&
    system_tags == other.system_tags &&
    is_latest_version == other.is_latest_version &&
    time_upgrade_required == other.time_upgrade_required &&
    deployment_type == other.deployment_type &&
    storage_utilization_in_bytes == other.storage_utilization_in_bytes &&
    is_storage_utilization_limit_exceeded == other.is_storage_utilization_limit_exceeded &&
    locks == other.locks
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



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 689

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


669
670
671
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 669

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



678
679
680
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 678

def hash
  [id, display_name, description, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_sub_state, lifecycle_details, freeform_tags, defined_tags, subnet_id, load_balancer_subnet_id, load_balancer_id, license_model, environment_type, category, fqdn, cpu_core_count, is_auto_scaling_enabled, is_public, public_ip_address, private_ip_address, deployment_url, system_tags, is_latest_version, time_upgrade_required, deployment_type, storage_utilization_in_bytes, is_storage_utilization_limit_exceeded, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



722
723
724
725
726
727
728
729
730
731
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 722

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



716
717
718
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 716

def to_s
  to_hash.to_s
end