Class: Google::Apis::AlloydbV1beta::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/alloydb_v1beta/classes.rb,
lib/google/apis/alloydb_v1beta/representations.rb,
lib/google/apis/alloydb_v1beta/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.



875
876
877
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 875

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


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

def annotations
  @annotations
end

#automated_backup_policy ⇒ Google::Apis::AlloydbV1beta::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:



646
647
648
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 646

def automated_backup_policy
  @automated_backup_policy
end

#backup_source ⇒ Google::Apis::AlloydbV1beta::BackupSource

Message describing a BackupSource. Corresponds to the JSON property backupSource

Returns:



651
652
653
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 651

def backup_source
  @backup_source
end

#backupdr_backup_source ⇒ Google::Apis::AlloydbV1beta::BackupDrBackupSource

Message describing a BackupDrBackupSource. Corresponds to the JSON property backupdrBackupSource

Returns:



656
657
658
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 656

def backupdr_backup_source
  @backupdr_backup_source
end

#backupdr_info ⇒ Google::Apis::AlloydbV1beta::BackupDrInfo

Information about BackupDR protection for this cluster. Corresponds to the JSON property backupdrInfo

Returns:



661
662
663
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 661

def backupdr_info
  @backupdr_info
end

#cloudsql_backup_run_source ⇒ Google::Apis::AlloydbV1beta::CloudSqlBackupRunSource

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

Returns:



666
667
668
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 666

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) 


674
675
676
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 674

def cluster_type
  @cluster_type
end

#continuous_backup_config ⇒ Google::Apis::AlloydbV1beta::ContinuousBackupConfig

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

Returns:



680
681
682
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 680

def continuous_backup_config
  @continuous_backup_config
end

#continuous_backup_info ⇒ Google::Apis::AlloydbV1beta::ContinuousBackupInfo

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

Returns:



685
686
687
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 685

def continuous_backup_info
  @continuous_backup_info
end

#create_time ⇒ String

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

Returns:

  • (String) 


690
691
692
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 690

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) 


698
699
700
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 698

def database_version
  @database_version
end

#dataplex_config ⇒ Google::Apis::AlloydbV1beta::DataplexConfig

Configuration for Dataplex integration. Corresponds to the JSON property dataplexConfig

Returns:



703
704
705
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 703

def dataplex_config
  @dataplex_config
end

#delete_time ⇒ String

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

Returns:

  • (String) 


708
709
710
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 708

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) 


713
714
715
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 713

def display_name
  @display_name
end

#encryption_config ⇒ Google::Apis::AlloydbV1beta::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:



719
720
721
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 719

def encryption_config
  @encryption_config
end

#encryption_info ⇒ Google::Apis::AlloydbV1beta::EncryptionInfo

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

Returns:



724
725
726
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 724

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) 


729
730
731
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 729

def etag
  @etag
end

#gemini_config ⇒ Google::Apis::AlloydbV1beta::GeminiClusterConfig

Deprecated and unused. This message will be removed in the near future. Corresponds to the JSON property geminiConfig

Returns:



734
735
736
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 734

def gemini_config
  @gemini_config
end

#initial_user ⇒ Google::Apis::AlloydbV1beta::UserPassword

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

Returns:



740
741
742
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 740

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


745
746
747
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 745

def labels
  @labels
end

#maintenance_schedule ⇒ Google::Apis::AlloydbV1beta::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:



754
755
756
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 754

def maintenance_schedule
  @maintenance_schedule
end

#maintenance_update_policy ⇒ Google::Apis::AlloydbV1beta::MaintenanceUpdatePolicy

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

Returns:



759
760
761
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 759

def maintenance_update_policy
  @maintenance_update_policy
end

#maintenance_version_selection_policy ⇒ String

Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. Corresponds to the JSON property maintenanceVersionSelectionPolicy

Returns:

  • (String) 


765
766
767
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 765

def maintenance_version_selection_policy
  @maintenance_version_selection_policy
end

#migration_source ⇒ Google::Apis::AlloydbV1beta::MigrationSource

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

Returns:



771
772
773
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 771

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) 


780
781
782
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 780

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) 


789
790
791
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 789

def network
  @network
end

#network_config ⇒ Google::Apis::AlloydbV1beta::NetworkConfig

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

Returns:



794
795
796
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 794

def network_config
  @network_config
end

#primary_config ⇒ Google::Apis::AlloydbV1beta::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:



801
802
803
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 801

def primary_config
  @primary_config
end

#psc_config ⇒ Google::Apis::AlloydbV1beta::PscConfig

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

Returns:



806
807
808
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 806

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) 


815
816
817
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 815

def reconciling
  @reconciling
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


821
822
823
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 821

def satisfies_pzs
  @satisfies_pzs
end

#secondary_config ⇒ Google::Apis::AlloydbV1beta::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:



828
829
830
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 828

def secondary_config
  @secondary_config
end

#service_account_email ⇒ String

Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. Corresponds to the JSON property serviceAccountEmail

Returns:

  • (String) 


835
836
837
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 835

def 
  @service_account_email
end

#ssl_config ⇒ Google::Apis::AlloydbV1beta::SslConfig

SSL configuration. Corresponds to the JSON property sslConfig

Returns:



840
841
842
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 840

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) 


845
846
847
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 845

def state
  @state
end

#subscription_type ⇒ String

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

Returns:

  • (String) 


850
851
852
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 850

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


857
858
859
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 857

def tags
  @tags
end

#trial_metadata ⇒ Google::Apis::AlloydbV1beta::TrialMetadata

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

Returns:



862
863
864
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 862

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) 


868
869
870
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 868

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


873
874
875
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 873

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 880

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)
  @backupdr_backup_source = args[:backupdr_backup_source] if args.key?(:backupdr_backup_source)
  @backupdr_info = args[:backupdr_info] if args.key?(:backupdr_info)
  @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)
  @dataplex_config = args[:dataplex_config] if args.key?(:dataplex_config)
  @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)
  @maintenance_version_selection_policy = args[:maintenance_version_selection_policy] if args.key?(:maintenance_version_selection_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_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @secondary_config = args[:secondary_config] if args.key?(:secondary_config)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @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