Class: OCI::GoldenGate::Models::Deployment

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

Overview

A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.

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
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_DATA_TRANSFORMS = 'DATA_TRANSFORMS'.freeze,
  DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
NEXT_MAINTENANCE_ACTION_TYPE_ENUM = 
[
  NEXT_MAINTENANCE_ACTION_TYPE_UPGRADE = 'UPGRADE'.freeze,
  NEXT_MAINTENANCE_ACTION_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 = {}) ⇒ Deployment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

  self.deployment_backup_id = attributes[:'deployment_backup_id'] if attributes[:'deployment_backup_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.is_healthy = attributes[:'isHealthy'] unless attributes[:'isHealthy'].nil?

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

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

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

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

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

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

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

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

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

  self.deployment_diagnostic_data = attributes[:'deploymentDiagnosticData'] if attributes[:'deploymentDiagnosticData']

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

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

  self.maintenance_window = attributes[:'maintenanceWindow'] if attributes[:'maintenanceWindow']

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

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

  self.time_of_next_maintenance = attributes[:'timeOfNextMaintenance'] if attributes[:'timeOfNextMaintenance']

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

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

  self.next_maintenance_action_type = attributes[:'nextMaintenanceActionType'] if attributes[:'nextMaintenanceActionType']

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

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

  self.next_maintenance_description = attributes[:'nextMaintenanceDescription'] if attributes[:'nextMaintenanceDescription']

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

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

  self.maintenance_configuration = attributes[:'maintenanceConfiguration'] if attributes[:'maintenanceConfiguration']

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

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

  self.time_ogg_version_supported_until = attributes[:'timeOggVersionSupportedUntil'] if attributes[:'timeOggVersionSupportedUntil']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 83

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

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

Returns:

  • (Integer) 


156
157
158
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 156

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


131
132
133
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 131

def defined_tags
  @defined_tags
end

#deployment_backup_id ⇒ String

The OCID of the backup being referenced.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 88

def deployment_backup_id
  @deployment_backup_id
end

#deployment_diagnostic_data ⇒ OCI::GoldenGate::Models::DeploymentDiagnosticData

Returns:



235
236
237
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 235

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


229
230
231
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 229

def deployment_type
  @deployment_type
end

#deployment_url ⇒ String

The URL of a resource.

Returns:

  • (String) 


187
188
189
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 187

def deployment_url
  @deployment_url
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 78

def description
  @description
end

#display_name ⇒ String

An object's Display Name.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 73

def display_name
  @display_name
end

#fqdn ⇒ String

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

Returns:

  • (String) 


146
147
148
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 146

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


124
125
126
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 124

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the deployment being referenced.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 68

def id
  @id
end

#is_auto_scaling_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


161
162
163
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 161

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_healthy ⇒ BOOLEAN

True if all of the aggregate resources are working correctly.

Returns:

  • (BOOLEAN) 


136
137
138
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 136

def is_healthy
  @is_healthy
end

#is_latest_version ⇒ BOOLEAN

Indicates if the resource is the the latest available version.

Returns:

  • (BOOLEAN) 


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

def is_latest_version
  @is_latest_version
end

#is_public ⇒ BOOLEAN

True if this object is publicly available.

Returns:

  • (BOOLEAN) 


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

def is_public
  @is_public
end

#is_storage_utilization_limit_exceeded ⇒ BOOLEAN

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) 


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

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) 


151
152
153
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 151

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) 


116
117
118
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 116

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Possible lifecycle states.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 105

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

Possible GGS lifecycle sub-states.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 110

def lifecycle_sub_state
  @lifecycle_sub_state
end

#maintenance_configuration ⇒ OCI::GoldenGate::Models::MaintenanceConfiguration

Returns:



257
258
259
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 257

def maintenance_configuration
  @maintenance_configuration
end

#maintenance_window ⇒ OCI::GoldenGate::Models::MaintenanceWindow

Returns:



238
239
240
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 238

def maintenance_window
  @maintenance_window
end

#next_maintenance_action_type ⇒ String

Type of the next maintenance.

Returns:

  • (String) 


249
250
251
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 249

def next_maintenance_action_type
  @next_maintenance_action_type
end

#next_maintenance_description ⇒ String

Description of the next maintenance.

Returns:

  • (String) 


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

def next_maintenance_description
  @next_maintenance_description
end

#nsg_ids ⇒ Array<String>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:

  • (Array<String>) 


166
167
168
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 166

def nsg_ids
  @nsg_ids
end

#ogg_data ⇒ OCI::GoldenGate::Models::OggDeployment

Returns:



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

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


182
183
184
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 182

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) 


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

def public_ip_address
  @public_ip_address
end

#storage_utilization_in_bytes ⇒ Integer

The amount of storage being utilized (in bytes)

Returns:

  • (Integer) 


217
218
219
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 217

def storage_utilization_in_bytes
  @storage_utilization_in_bytes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet being referenced.

Returns:

  • (String) 


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

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


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

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) 


94
95
96
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 94

def time_created
  @time_created
end

#time_of_next_maintenance ⇒ DateTime

The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


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

def time_of_next_maintenance
  @time_of_next_maintenance
end

#time_ogg_version_supported_until ⇒ DateTime

The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


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

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


100
101
102
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 100

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) 


212
213
214
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 212

def time_upgrade_required
  @time_upgrade_required
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'deployment_backup_id': :'deploymentBackupId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_sub_state': :'lifecycleSubState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'is_healthy': :'isHealthy',
    'subnet_id': :'subnetId',
    'fqdn': :'fqdn',
    'license_model': :'licenseModel',
    'cpu_core_count': :'cpuCoreCount',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'nsg_ids': :'nsgIds',
    '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',
    'storage_utilization_in_bytes': :'storageUtilizationInBytes',
    'is_storage_utilization_limit_exceeded': :'isStorageUtilizationLimitExceeded',
    'deployment_type': :'deploymentType',
    'ogg_data': :'oggData',
    'deployment_diagnostic_data': :'deploymentDiagnosticData',
    'maintenance_window': :'maintenanceWindow',
    'time_of_next_maintenance': :'timeOfNextMaintenance',
    'next_maintenance_action_type': :'nextMaintenanceActionType',
    'next_maintenance_description': :'nextMaintenanceDescription',
    'maintenance_configuration': :'maintenanceConfiguration',
    'time_ogg_version_supported_until': :'timeOggVersionSupportedUntil'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 311

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'deployment_backup_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>>',
    'is_healthy': :'BOOLEAN',
    'subnet_id': :'String',
    'fqdn': :'String',
    'license_model': :'String',
    'cpu_core_count': :'Integer',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'nsg_ids': :'Array<String>',
    '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',
    'storage_utilization_in_bytes': :'Integer',
    'is_storage_utilization_limit_exceeded': :'BOOLEAN',
    'deployment_type': :'String',
    'ogg_data': :'OCI::GoldenGate::Models::OggDeployment',
    'deployment_diagnostic_data': :'OCI::GoldenGate::Models::DeploymentDiagnosticData',
    'maintenance_window': :'OCI::GoldenGate::Models::MaintenanceWindow',
    'time_of_next_maintenance': :'DateTime',
    'next_maintenance_action_type': :'String',
    'next_maintenance_description': :'String',
    'maintenance_configuration': :'OCI::GoldenGate::Models::MaintenanceConfiguration',
    'time_ogg_version_supported_until': :'DateTime'
    # 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



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 687

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 &&
    deployment_backup_id == other.deployment_backup_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 &&
    is_healthy == other.is_healthy &&
    subnet_id == other.subnet_id &&
    fqdn == other.fqdn &&
    license_model == other.license_model &&
    cpu_core_count == other.cpu_core_count &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    nsg_ids == other.nsg_ids &&
    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 &&
    storage_utilization_in_bytes == other.storage_utilization_in_bytes &&
    is_storage_utilization_limit_exceeded == other.is_storage_utilization_limit_exceeded &&
    deployment_type == other.deployment_type &&
    ogg_data == other.ogg_data &&
    deployment_diagnostic_data == other.deployment_diagnostic_data &&
    maintenance_window == other.maintenance_window &&
    time_of_next_maintenance == other.time_of_next_maintenance &&
    next_maintenance_action_type == other.next_maintenance_action_type &&
    next_maintenance_description == other.next_maintenance_description &&
    maintenance_configuration == other.maintenance_configuration &&
    time_ogg_version_supported_until == other.time_ogg_version_supported_until
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



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 753

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


733
734
735
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 733

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



742
743
744
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 742

def hash
  [id, display_name, description, compartment_id, deployment_backup_id, time_created, time_updated, lifecycle_state, lifecycle_sub_state, lifecycle_details, freeform_tags, defined_tags, is_healthy, subnet_id, fqdn, license_model, cpu_core_count, is_auto_scaling_enabled, nsg_ids, is_public, public_ip_address, private_ip_address, deployment_url, system_tags, is_latest_version, time_upgrade_required, storage_utilization_in_bytes, is_storage_utilization_limit_exceeded, deployment_type, ogg_data, deployment_diagnostic_data, maintenance_window, time_of_next_maintenance, next_maintenance_action_type, next_maintenance_description, maintenance_configuration, time_ogg_version_supported_until].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



786
787
788
789
790
791
792
793
794
795
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 786

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



780
781
782
 
# File 'lib/oci/golden_gate/models/deployment.rb', line 780

def to_s
  to_hash.to_s
end