Struct Cluster

pub struct Cluster {

    pub name: String,
    pub display_name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub state: i32,
    pub cluster_type: i32,
    pub database_version: i32,
    pub network_config: Option<NetworkConfig>,
    pub network: String,
    pub etag: String,
    pub annotations: HashMap<String, String>,
    pub reconciling: bool,
    pub initial_user: Option<UserPassword>,
    pub automated_backup_policy: Option<AutomatedBackupPolicy>,
    pub ssl_config: Option<SslConfig>,
    pub encryption_config: Option<EncryptionConfig>,
    pub encryption_info: Option<EncryptionInfo>,
    pub continuous_backup_config: Option<ContinuousBackupConfig>,
    pub continuous_backup_info: Option<ContinuousBackupInfo>,
    pub secondary_config: Option<SecondaryConfig>,
    pub primary_config: Option<PrimaryConfig>,
    pub satisfies_pzs: bool,
    pub psc_config: Option<PscConfig>,
    pub maintenance_update_policy: Option<MaintenanceUpdatePolicy>,
    pub maintenance_schedule: Option<MaintenanceSchedule>,
    pub gemini_config: Option<GeminiClusterConfig>,
    pub subscription_type: i32,
    pub trial_metadata: Option<TrialMetadata>,
    pub tags: HashMap<String, String>,
    pub source: Option<Source>,
}

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.

Fields

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}

display_name: String

User-settable and human-readable display name for the Cluster.

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.

create_time: Option<Timestamp>

Output only. Create time stamp

update_time: Option<Timestamp>

Output only. Update time stamp

delete_time: Option<Timestamp>

Output only. Delete time stamp

labels: HashMap<String, String>

Labels as key value pairs

state: i32

Output only. The current serving state of the cluster.

cluster_type: i32

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

database_version: i32

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.

network_config: Option<NetworkConfig>

network: String

👎Deprecated

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.

etag: String

For Resource freshness validation (https://google.aip.dev/154)

annotations: HashMap<String, String>

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

reconciling: bool

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.

initial_user: Option<UserPassword>

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

automated_backup_policy: Option<AutomatedBackupPolicy>

The automated backup policy for this cluster.

If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

ssl_config: Option<SslConfig>

👎Deprecated

SSL configuration for this AlloyDB cluster.

encryption_config: Option<EncryptionConfig>

Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

encryption_info: Option<EncryptionInfo>

Output only. The encryption information for the cluster.

continuous_backup_config: Option<ContinuousBackupConfig>

Optional. Continuous backup configuration for this cluster.

continuous_backup_info: Option<ContinuousBackupInfo>

Output only. Continuous backup properties for this cluster.

secondary_config: Option<SecondaryConfig>

Cross Region replication config specific to SECONDARY cluster.

primary_config: Option<PrimaryConfig>

Output only. Cross Region replication config specific to PRIMARY cluster.

satisfies_pzs: bool

Output only. Reserved for future use.

psc_config: Option<PscConfig>

Optional. The configuration for Private Service Connect (PSC) for the cluster.

maintenance_update_policy: Option<MaintenanceUpdatePolicy>

Optional. The maintenance update policy determines when to allow or deny updates.

maintenance_schedule: Option<MaintenanceSchedule>

Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

gemini_config: Option<GeminiClusterConfig>

Optional. Configuration parameters related to the Gemini in Databases add-on.

subscription_type: i32

Optional. Subscription type of the cluster.

trial_metadata: Option<TrialMetadata>

Output only. Metadata for free trial clusters

tags: HashMap<String, String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

"123/environment": "production",
"123/costCenter": "marketing"

source: Option<Source>

In case of an imported cluster, this field contains information about the source this cluster was imported from.

Implementations

impl Cluster

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn database_version(&self) -> DatabaseVersion

Returns the enum value of database_version, or the default if the field is set to an invalid enum value.

pub fn set_database_version(&mut self, value: DatabaseVersion)

Sets database_version to the provided enum value.

pub fn cluster_type(&self) -> ClusterType

Returns the enum value of cluster_type, or the default if the field is set to an invalid enum value.

pub fn set_cluster_type(&mut self, value: ClusterType)

Sets cluster_type to the provided enum value.

pub fn subscription_type(&self) -> SubscriptionType

Returns the enum value of subscription_type, or the default if the field is set to an invalid enum value.

pub fn set_subscription_type(&mut self, value: SubscriptionType)

Sets subscription_type to the provided enum value.

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Cluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Cluster

fn default() -> Self

Returns the “default value” for a type.

impl Message for Cluster

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Cluster

fn eq(&self, other: &Cluster) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Cluster