Class: Google::Apis::AlloydbV1alpha::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/alloydb_v1alpha/classes.rb,
lib/google/apis/alloydb_v1alpha/representations.rb,
lib/google/apis/alloydb_v1alpha/representations.rb

Overview

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.



657
658
659
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 657

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


442
443
444
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 442

def annotations
  @annotations
end

#automated_backup_policy ⇒ Google::Apis::AlloydbV1alpha::AutomatedBackupPolicy

Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. Corresponds to the JSON property automatedBackupPolicy

Returns:



449
450
451
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 449

def automated_backup_policy
  @automated_backup_policy
end

#backup_source ⇒ Google::Apis::AlloydbV1alpha::BackupSource

Message describing a BackupSource. Corresponds to the JSON property backupSource

Returns:



454
455
456
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 454

def backup_source
  @backup_source
end

#cloudsql_backup_run_source ⇒ Google::Apis::AlloydbV1alpha::CloudSqlBackupRunSource

The source CloudSQL backup resource. Corresponds to the JSON property cloudsqlBackupRunSource

Returns:



459
460
461
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 459

def cloudsql_backup_run_source
  @cloudsql_backup_run_source
end

#cluster_type ⇒ String

Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster Corresponds to the JSON property clusterType

Returns:

  • (String) 


467
468
469
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 467

def cluster_type
  @cluster_type
end

#continuous_backup_config ⇒ Google::Apis::AlloydbV1alpha::ContinuousBackupConfig

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. Corresponds to the JSON property continuousBackupConfig

Returns:



473
474
475
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 473

def continuous_backup_config
  @continuous_backup_config
end

#continuous_backup_info ⇒ Google::Apis::AlloydbV1alpha::ContinuousBackupInfo

ContinuousBackupInfo describes the continuous backup properties of a cluster. Corresponds to the JSON property continuousBackupInfo

Returns:



478
479
480
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 478

def continuous_backup_info
  @continuous_backup_info
end

#create_time ⇒ String

Output only. Create time stamp Corresponds to the JSON property createTime

Returns:

  • (String) 


483
484
485
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 483

def create_time
  @create_time
end

#database_version ⇒ String

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


491
492
493
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 491

def database_version
  @database_version
end

#delete_time ⇒ String

Output only. Delete time stamp Corresponds to the JSON property deleteTime

Returns:

  • (String) 


496
497
498
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 496

def delete_time
  @delete_time
end

#display_name ⇒ String

User-settable and human-readable display name for the Cluster. Corresponds to the JSON property displayName

Returns:

  • (String) 


501
502
503
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 501

def display_name
  @display_name
end

#encryption_config ⇒ Google::Apis::AlloydbV1alpha::EncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Corresponds to the JSON property encryptionConfig

Returns:



507
508
509
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 507

def encryption_config
  @encryption_config
end

#encryption_info ⇒ Google::Apis::AlloydbV1alpha::EncryptionInfo

EncryptionInfo describes the encryption information of a cluster or a backup. Corresponds to the JSON property encryptionInfo

Returns:



512
513
514
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 512

def encryption_info
  @encryption_info
end

#etag ⇒ String

For Resource freshness validation (https://google.aip.dev/154) Corresponds to the JSON property etag

Returns:

  • (String) 


517
518
519
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 517

def etag
  @etag
end

#gemini_config ⇒ Google::Apis::AlloydbV1alpha::GeminiClusterConfig

Cluster level configuration parameters related to the Gemini in Databases add- on. Corresponds to the JSON property geminiConfig

Returns:



523
524
525
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 523

def gemini_config
  @gemini_config
end

#initial_user ⇒ Google::Apis::AlloydbV1alpha::UserPassword

The username/password for a database user. Used for specifying initial users at cluster creation time. Corresponds to the JSON property initialUser

Returns:



529
530
531
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 529

def initial_user
  @initial_user
end

#labels ⇒ Hash<String,String>

Labels as key value pairs Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


534
535
536
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 534

def labels
  @labels
end

#maintenance_schedule ⇒ Google::Apis::AlloydbV1alpha::MaintenanceSchedule

MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead. Corresponds to the JSON property maintenanceSchedule

Returns:



543
544
545
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 543

def maintenance_schedule
  @maintenance_schedule
end

#maintenance_update_policy ⇒ Google::Apis::AlloydbV1alpha::MaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Corresponds to the JSON property maintenanceUpdatePolicy

Returns:



548
549
550
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 548

def maintenance_update_policy
  @maintenance_update_policy
end

#migration_source ⇒ Google::Apis::AlloydbV1alpha::MigrationSource

Subset of the source instance configuration that is available when reading the cluster resource. Corresponds to the JSON property migrationSource

Returns:



554
555
556
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 554

def migration_source
  @migration_source
end

#name ⇒ String

Output only. The name of the cluster resource with the format: * projects/ project/locations/region/clusters/cluster_id where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https:// google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/project/locations/region Corresponds to the JSON property name

Returns:

  • (String) 


563
564
565
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 563

def name
  @name
end

#network ⇒ String

Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/project/global/networks/network_id`. This is required to create a cluster. Deprecated, use network_config.network instead. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


572
573
574
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 572

def network
  @network
end

#network_config ⇒ Google::Apis::AlloydbV1alpha::NetworkConfig

Metadata related to network configuration. Corresponds to the JSON property networkConfig

Returns:



577
578
579
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 577

def network_config
  @network_config
end

#primary_config ⇒ Google::Apis::AlloydbV1alpha::PrimaryConfig

Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. Corresponds to the JSON property primaryConfig

Returns:



584
585
586
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 584

def primary_config
  @primary_config
end

#psc_config ⇒ Google::Apis::AlloydbV1alpha::PscConfig

PscConfig contains PSC related configuration at a cluster level. Corresponds to the JSON property pscConfig

Returns:



589
590
591
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 589

def psc_config
  @psc_config
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


598
599
600
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 598

def reconciling
  @reconciling
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


604
605
606
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 604

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


610
611
612
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 610

def satisfies_pzs
  @satisfies_pzs
end

#secondary_config ⇒ Google::Apis::AlloydbV1alpha::SecondaryConfig

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. Corresponds to the JSON property secondaryConfig

Returns:



617
618
619
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 617

def secondary_config
  @secondary_config
end

#ssl_config ⇒ Google::Apis::AlloydbV1alpha::SslConfig

SSL configuration. Corresponds to the JSON property sslConfig

Returns:



622
623
624
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 622

def ssl_config
  @ssl_config
end

#state ⇒ String

Output only. The current serving state of the cluster. Corresponds to the JSON property state

Returns:

  • (String) 


627
628
629
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 627

def state
  @state
end

#subscription_type ⇒ String

Optional. Subscription type of the cluster. Corresponds to the JSON property subscriptionType

Returns:

  • (String) 


632
633
634
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 632

def subscription_type
  @subscription_type
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


639
640
641
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 639

def tags
  @tags
end

#trial_metadata ⇒ Google::Apis::AlloydbV1alpha::TrialMetadata

Contains information and all metadata related to TRIAL clusters. Corresponds to the JSON property trialMetadata

Returns:



644
645
646
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 644

def trial_metadata
  @trial_metadata
end

#uid ⇒ String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. Corresponds to the JSON property uid

Returns:

  • (String) 


650
651
652
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 650

def uid
  @uid
end

#update_time ⇒ String

Output only. Update time stamp Corresponds to the JSON property updateTime

Returns:

  • (String) 


655
656
657
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 655

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 662

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @automated_backup_policy = args[:automated_backup_policy] if args.key?(:automated_backup_policy)
  @backup_source = args[:backup_source] if args.key?(:backup_source)
  @cloudsql_backup_run_source = args[:cloudsql_backup_run_source] if args.key?(:cloudsql_backup_run_source)
  @cluster_type = args[:cluster_type] if args.key?(:cluster_type)
  @continuous_backup_config = args[:continuous_backup_config] if args.key?(:continuous_backup_config)
  @continuous_backup_info = args[:continuous_backup_info] if args.key?(:continuous_backup_info)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database_version = args[:database_version] if args.key?(:database_version)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
  @etag = args[:etag] if args.key?(:etag)
  @gemini_config = args[:gemini_config] if args.key?(:gemini_config)
  @initial_user = args[:initial_user] if args.key?(:initial_user)
  @labels = args[:labels] if args.key?(:labels)
  @maintenance_schedule = args[:maintenance_schedule] if args.key?(:maintenance_schedule)
  @maintenance_update_policy = args[:maintenance_update_policy] if args.key?(:maintenance_update_policy)
  @migration_source = args[:migration_source] if args.key?(:migration_source)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_config = args[:network_config] if args.key?(:network_config)
  @primary_config = args[:primary_config] if args.key?(:primary_config)
  @psc_config = args[:psc_config] if args.key?(:psc_config)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @secondary_config = args[:secondary_config] if args.key?(:secondary_config)
  @ssl_config = args[:ssl_config] if args.key?(:ssl_config)
  @state = args[:state] if args.key?(:state)
  @subscription_type = args[:subscription_type] if args.key?(:subscription_type)
  @tags = args[:tags] if args.key?(:tags)
  @trial_metadata = args[:trial_metadata] if args.key?(:trial_metadata)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end