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_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_DATA_VERIFICATION = 'DATA_VERIFICATION'.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_DATABASE_DB2_I = 'DATABASE_DB2I'.freeze,
  DEPLOYMENT_TYPE_GGSA = 'GGSA'.freeze,
  DEPLOYMENT_TYPE_DATA_TRANSFORMS = 'DATA_TRANSFORMS'.freeze,
  DEPLOYMENT_TYPE_VERIDATA_SERVER = 'VERIDATA_SERVER'.freeze,
  DEPLOYMENT_TYPE_VERIDATA_AGENT = 'VERIDATA_AGENT'.freeze,
  DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DISASTER_RECOVERY_STATUS_ENUM = 
[
  DISASTER_RECOVERY_STATUS_ENABLED = 'ENABLED'.freeze,
  DISASTER_RECOVERY_STATUS_DISABLED = 'DISABLED'.freeze,
  DISASTER_RECOVERY_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DEPLOYMENT_ROLE_ENUM = 
[
  DEPLOYMENT_ROLE_PRIMARY = 'PRIMARY'.freeze,
  DEPLOYMENT_ROLE_STANDBY = 'STANDBY'.freeze,
  DEPLOYMENT_ROLE_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):



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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 428

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.is_byol_cpu_core_count_limit_enabled = attributes[:'isByolCpuCoreCountLimitEnabled'] unless attributes[:'isByolCpuCoreCountLimitEnabled'].nil?
  self.is_byol_cpu_core_count_limit_enabled = false if is_byol_cpu_core_count_limit_enabled.nil? && !attributes.key?(:'isByolCpuCoreCountLimitEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_byol_cpu_core_count_limit_enabled = attributes[:'is_byol_cpu_core_count_limit_enabled'] unless attributes[:'is_byol_cpu_core_count_limit_enabled'].nil?
  self.is_byol_cpu_core_count_limit_enabled = false if is_byol_cpu_core_count_limit_enabled.nil? && !attributes.key?(:'isByolCpuCoreCountLimitEnabled') && !attributes.key?(:'is_byol_cpu_core_count_limit_enabled') # rubocop:disable Style/StringLiterals

  self.byol_cpu_core_count_limit = attributes[:'byolCpuCoreCountLimit'] if attributes[:'byolCpuCoreCountLimit']

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

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

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

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

  self.disaster_recovery_status = attributes[:'disasterRecoveryStatus'] if attributes[:'disasterRecoveryStatus']

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

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

  self.deployment_role = attributes[:'deploymentRole'] if attributes[:'deploymentRole']

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

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

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

Instance Attribute Details

#byol_cpu_core_count_limit ⇒ Integer

The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed.

Returns:

  • (Integer) 


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

def byol_cpu_core_count_limit
  @byol_cpu_core_count_limit
end

#category ⇒ String

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

Returns:

  • (String) 


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

def category
  @category
end

#cluster_placement_group_id ⇒ String

The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

Returns:

  • (String) 


270
271
272
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 270

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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


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

def defined_tags
  @defined_tags
end

#deployment_role ⇒ String

The type of the deployment role.

Returns:

  • (String) 


289
290
291
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 289

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


248
249
250
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 248

def deployment_type
  @deployment_type
end

#deployment_url ⇒ String

The URL of a resource.

Returns:

  • (String) 


227
228
229
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 227

def deployment_url
  @deployment_url
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


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

def description
  @description
end

#disaster_recovery_status ⇒ String

Indicates if disaster recovery is enabled for a deployment. If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

Returns:

  • (String) 


284
285
286
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 284

def disaster_recovery_status
  @disaster_recovery_status
end

#display_name ⇒ String

An object's Display Name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#environment_type ⇒ String

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

Returns:

  • (String) 


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

def environment_type
  @environment_type
end

#fqdn ⇒ String

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

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the deployment being referenced.

Returns:

  • (String) 


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

def id
  @id
end

#is_auto_scaling_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_byol_cpu_core_count_limit_enabled ⇒ BOOLEAN

Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

Returns:

  • (BOOLEAN) 


174
175
176
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 174

def is_byol_cpu_core_count_limit_enabled
  @is_byol_cpu_core_count_limit_enabled
end

#is_latest_version ⇒ BOOLEAN

Indicates if the resource is the the latest available version.

Returns:

  • (BOOLEAN) 


241
242
243
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 241

def is_latest_version
  @is_latest_version
end

#is_public ⇒ BOOLEAN

True if this object is publicly available.

Returns:

  • (BOOLEAN) 


211
212
213
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 211

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) 


259
260
261
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 259

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) 


168
169
170
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 168

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) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Possible lifecycle states for a Deployment.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

Possible GGS lifecycle sub-states.

Returns:

  • (String) 


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

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) 


163
164
165
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 163

def load_balancer_id
  @load_balancer_id
end

#load_balancer_subnet_id ⇒ String

The OCID of a public subnet in the customer tenancy used to host the public load balancer of the deployment.

Rules: - Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId. - Update: - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet). - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.

Validation: - Must reference a public subnet. - Must be a regional subnet. - Must be in the same VCN as subnetId.

Returns:

  • (String) 


157
158
159
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 157

def load_balancer_subnet_id
  @load_balancer_subnet_id
end

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

Locks associated with this resource.

Returns:



293
294
295
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 293

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) 


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

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) 


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

def public_ip_address
  @public_ip_address
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


278
279
280
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 278

def security_attributes
  @security_attributes
end

#storage_utilization_in_bytes ⇒ Integer

The amount of storage being utilized (in bytes)

Returns:

  • (Integer) 


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

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) 


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

def subnet_id
  @subnet_id
end

#subscription_id ⇒ String

The OCID of the subscription with which resource needs to be associated with.

Returns:

  • (String) 


263
264
265
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 263

def subscription_id
  @subscription_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>>) 


236
237
238
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 236

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) 


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

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) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'is_byol_cpu_core_count_limit_enabled': :'isByolCpuCoreCountLimitEnabled',
    'byol_cpu_core_count_limit': :'byolCpuCoreCountLimit',
    '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',
    'deployment_type': :'deploymentType',
    'storage_utilization_in_bytes': :'storageUtilizationInBytes',
    'is_storage_utilization_limit_exceeded': :'isStorageUtilizationLimitExceeded',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'disaster_recovery_status': :'disasterRecoveryStatus',
    'deployment_role': :'deploymentRole',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 341

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',
    'is_byol_cpu_core_count_limit_enabled': :'BOOLEAN',
    'byol_cpu_core_count_limit': :'Integer',
    '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',
    'deployment_type': :'String',
    'storage_utilization_in_bytes': :'Integer',
    'is_storage_utilization_limit_exceeded': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'disaster_recovery_status': :'String',
    'deployment_role': :'String',
    '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



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 737

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 &&
    is_byol_cpu_core_count_limit_enabled == other.is_byol_cpu_core_count_limit_enabled &&
    byol_cpu_core_count_limit == other.byol_cpu_core_count_limit &&
    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 &&
    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 &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes &&
    disaster_recovery_status == other.disaster_recovery_status &&
    deployment_role == other.deployment_role &&
    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



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 803

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


783
784
785
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 783

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



792
793
794
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 792

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, is_byol_cpu_core_count_limit_enabled, byol_cpu_core_count_limit, 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, deployment_type, storage_utilization_in_bytes, is_storage_utilization_limit_exceeded, subscription_id, cluster_placement_group_id, security_attributes, disaster_recovery_status, deployment_role, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



836
837
838
839
840
841
842
843
844
845
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 836

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



830
831
832
 
# File 'lib/oci/golden_gate/models/deployment_summary.rb', line 830

def to_s
  to_hash.to_s
end