Package types (0.3.10)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message describing Backup object

Message describing a BackupSource.

Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, Instance1 through Instance4. Lets also assume that 2 instances succeeded but the third failed to create and the 4th was never picked up for creation because of failure of the previous one. Then, resulting states would look something like:

1. Instance1 = ROLLED_BACK
2. Instance2 = ROLLED_BACK
3. Instance3 = FAILED
4. Instance4 = FAILED

However, while the operation is running, the instance might be in other states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states / do not get further updated once the operation is done.

Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3

Message for creating a batch of instances under the specified cluster.

Message for creating batches of instances in a cluster.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

View on Cluster. Pass this enum to rpcs that returns a cluster message to control which subsets of fields to get.

Values: CLUSTER_VIEW_UNSPECIFIED (0): CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC. CLUSTER_VIEW_BASIC (1): BASIC server responses include all the relevant cluster details, excluding Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific fields. The default value. CLUSTER_VIEW_CONTINUOUS_BACKUP (2): CONTINUOUS_BACKUP response returns all the fields from BASIC plus the earliest restorable time if continuous backups are enabled. May increase latency.

ConnectionInfo singleton resource. https://google.aip.dev/156

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ContinuousBackupInfo describes the continuous backup properties of a cluster.

Message describing a ContinuousBackupSource.

Message for creating a Backup

Message for creating a Cluster

Message for creating a Instance

See usage below for notes.

Message for creating a Secondary Instance

Message for creating a User

Message describing Database object.

The supported database engine versions.

Values: DATABASE_VERSION_UNSPECIFIED (0): This is an unknown database version. POSTGRES_13 (1): DEPRECATED - The database version is Postgres 13. POSTGRES_14 (2): The database version is Postgres 14. POSTGRES_15 (3): The database version is Postgres 15.

Message for deleting a Backup

Message for deleting a Cluster

Message for deleting a Instance

Message for deleting a User

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

EncryptionInfo describes the encryption information of a cluster or a backup.

Message for triggering failover on an Instance

Message for requests to generate a client certificate signed by the Cluster CA.

Message returned by a GenerateClientCertificate operation.

Message for getting a Backup

Message for getting a Cluster

Request message for GetConnectionInfo.

Message for getting a Instance

Message for getting a User

Message for triggering fault injection on an instance

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.

Values: INSTANCE_VIEW_UNSPECIFIED (0): INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC. INSTANCE_VIEW_BASIC (1): BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value. INSTANCE_VIEW_FULL (2): FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool.

Message for requesting list of Backups

Message for response to listing Backups

Message for requesting list of Clusters

Message for response to listing Clusters

Message for requesting list of Databases.

Message for response to listing Databases.

Message for requesting list of Instances

Message for response to listing Instances

Message for listing the information about the supported Database flags.

Message for response to listing SupportedDatabaseFlags.

Message for requesting list of Users

Message for response to listing Users

Subset of the source instance configuration that is available when reading the cluster resource.

Represents the metadata of the long-running operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for promoting a Cluster

Message for restoring a Cluster from a backup or another cluster at a given point in time.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SSL configuration.

SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for updating a Backup

Message for updating a Cluster

Message for updating a Instance

Message for updating a User

Message describing User object.

The username/password for a database user. Used for specifying initial users at cluster creation time.