Package Classes (0.4.0)

Service describing handlers for resources

Service describing handlers for resources

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __aiter__ method to iterate through its databases field.

If there are more pages, the __aiter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __iter__ method to iterate through its databases field.

If there are more pages, the __iter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __aiter__ method to iterate through its supported_database_flags field.

If there are more pages, the __aiter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __iter__ method to iterate through its supported_database_flags field.

If there are more pages, the __iter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __aiter__ method to iterate through its users field.

If there are more pages, the __aiter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __iter__ method to iterate through its users field.

If there are more pages, the __iter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

The abstract base class for a message.

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

A time based retention policy specifies that all backups within a certain time period should be retained.

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.

The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the start_times field to have one element "22:00" and the days_of_week field to have all seven days of the week.

Message describing Backup object

The abstract base class for a message.

The abstract base class for a message.

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

Backup State

The abstract base class for a message.

Backup Type

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.

State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.

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

The abstract base class for a message.

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

The abstract base class for a message.

Type of Cluster

The abstract base class for a message.

Metadata related to network configuration.

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.

PscConfig contains PSC related configuration at a cluster level.

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

Cluster State

The abstract base class for a message.

Contains information and all metadata related to TRIAL clusters.

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

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.

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.

Possible encryption types.

Any additional metadata information regarding the execution of the SQL

Status contains all valid Status a SQL execution can end up in.

Request for ExecuteSql rpc.

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

Execute a SQL statement response.

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

FaultType contains all valid types of faults that can be injected to 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.

The abstract base class for a message.

The Availability type of an instance. Potential values:

• ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
• REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Client connection configuration

The abstract base class for a message.

Metadata related to instance-level network configuration.

AuthorizedNetwork contains metadata for an authorized network.

Type of an Instance

    -  Read pool of size 1 can only have zonal availability.
    -  Read pools with node count of 2 or more can have regional
       availability (nodes are present in 2 or more zones in a
       region).
SECONDARY (3):
    SECONDARY instances support read operations
    only. SECONDARY instance is a cross-region read
    replica

The abstract base class for a message.

MachineConfig describes the configuration of a machine.

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

PscInstanceConfig contains PSC related configuration at an instance level.

QueryInsights Instance specific configuration.

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

Configuration for a read pool instance.

Instance State

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

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

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.

MaintenanceUpdatePolicy defines the policy for system updates.

MaintenanceWindow specifies a preferred day and time for maintenance.

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

Denote the type of migration source that created this cluster.

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

SqlResult represents the result for the execution of a sql statement.

Contains the name and datatype of a column in a SQL Result.

A single row from a sql result.

A single value in a row from a sql result.

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

SSL configuration.

Certificate Authority (CA) source for SSL/TLS certificates.

SSL mode options.

Subscription_type added to distinguish between Standard and Trial subscriptions. By default, a subscription type is considered STANDARD unless explicitly specified.

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

Restrictions on INTEGER type values.

Restrictions on STRING type values

ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14".

Message for switching over to a cluster

Message for updating a Backup

Message for updating a Cluster

Message for updating a Instance

Message for updating a User

Message describing User object.

Enum that details the user type.

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

Service describing handlers for resources

Service describing handlers for resources

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __aiter__ method to iterate through its databases field.

If there are more pages, the __aiter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __iter__ method to iterate through its databases field.

If there are more pages, the __iter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __aiter__ method to iterate through its supported_database_flags field.

If there are more pages, the __aiter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __iter__ method to iterate through its supported_database_flags field.

If there are more pages, the __iter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __aiter__ method to iterate through its users field.

If there are more pages, the __aiter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __iter__ method to iterate through its users field.

If there are more pages, the __iter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

The abstract base class for a message.

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

A time based retention policy specifies that all backups within a certain time period should be retained.

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.

The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the start_times field to have one element "22:00" and the days_of_week field to have all seven days of the week.

Message describing Backup object

The abstract base class for a message.

The abstract base class for a message.

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

Backup State

The abstract base class for a message.

Backup Type

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.

State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.

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

The abstract base class for a message.

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

Message for creating batches of instances in a cluster.

The source CloudSQL backup resource.

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

The abstract base class for a message.

Type of Cluster

The abstract base class for a message.

Metadata related to network configuration.

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.

PscConfig contains PSC related configuration at a cluster level.

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

Cluster State

The abstract base class for a message.

Contains information and all metadata related to TRIAL clusters.

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

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.

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.

Possible encryption types.

Any additional metadata information regarding the execution of the SQL

Status contains all valid Status a SQL execution can end up in.

Request for ExecuteSql rpc.

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

Execute a SQL statement response.

Message for triggering failover on an Instance

Cluster level configuration parameters related to the Gemini in Databases add-on.

Instance level configuration parameters related to the Gemini in Databases add-on.

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

FaultType contains all valid types of faults that can be injected to 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.

The abstract base class for a message.

The Availability type of an instance. Potential values:

• ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
• REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Client connection configuration

The abstract base class for a message.

Metadata related to instance-level network configuration.

AuthorizedNetwork contains metadata for an authorized network.

Type of an Instance

    -  Read pool of size 1 can only have zonal availability.
    -  Read pools with node count of 2 or more can have regional
       availability (nodes are present in 2 or more zones in a
       region).
SECONDARY (3):
    SECONDARY instances support read operations
    only. SECONDARY instance is a cross-region read
    replica

The abstract base class for a message.

MachineConfig describes the configuration of a machine.

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

Observability Instance specific configuration.

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

PscInstanceConfig contains PSC related configuration at an instance level.

Configuration for setting up a PSC interface to enable outbound connectivity.

QueryInsights Instance specific configuration.

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

Configuration for a read pool instance.

Instance State

Policy to be used while updating the instance.

Specifies the available modes of update.

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

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

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.

MaintenanceUpdatePolicy defines the policy for system updates.

MaintenanceWindow specifies a preferred day and time for maintenance.

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

Denote the type of migration source that created this cluster.

Represents the metadata of the long-running operation.

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 promoting a Cluster

Message for current status of the database during Promote Cluster operation.

State contains all valid states of the database during promote cluster operation. This is used for status reporting through the LRO metadata.

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

SqlResult represents the result for the execution of a sql statement.

Contains the name and datatype of a column in a SQL Result.

A single row from a sql result.

A single value in a row from a sql result.

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

SSL configuration.

Certificate Authority (CA) source for SSL/TLS certificates.

SSL mode options.

Subscription_type added to distinguish between Standard and Trial subscriptions. By default, a subscription type is considered STANDARD unless explicitly specified.

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

Restrictions on INTEGER type values.

Restrictions on STRING type values

ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14".

Message for switching over to a cluster

Message for updating a Backup

Message for updating a Cluster

Message for updating a Instance

Message for updating a User

Upgrades a cluster.

UpgradeClusterResponse contains the response for upgrade cluster operation.

Upgrade details of a cluster. This cluster can be primary or secondary.

Details regarding the upgrade of instaces associated with a cluster.

Stage in the upgrade.

Stage information for different stages in the upgrade process.

Status of upgrade operation.

Message for current status of the Major Version Upgrade operation.

Read pool instances upgrade specific status.

Upgrade stats for read pool instances.

Status of an upgrade stage.

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

Message describing User object.

Enum that details the user type.

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

Service describing handlers for resources

Service describing handlers for resources

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __aiter__ method to iterate through its databases field.

If there are more pages, the __aiter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_databases requests.

This class thinly wraps an initial ListDatabasesResponse object, and provides an __iter__ method to iterate through its databases field.

If there are more pages, the __iter__ method will make additional ListDatabases requests and continue to iterate through the databases field on the corresponding responses.

All the usual ListDatabasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __aiter__ method to iterate through its supported_database_flags field.

If there are more pages, the __aiter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_supported_database_flags requests.

This class thinly wraps an initial ListSupportedDatabaseFlagsResponse object, and provides an __iter__ method to iterate through its supported_database_flags field.

If there are more pages, the __iter__ method will make additional ListSupportedDatabaseFlags requests and continue to iterate through the supported_database_flags field on the corresponding responses.

All the usual ListSupportedDatabaseFlagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __aiter__ method to iterate through its users field.

If there are more pages, the __aiter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_users requests.

This class thinly wraps an initial ListUsersResponse object, and provides an __iter__ method to iterate through its users field.

If there are more pages, the __iter__ method will make additional ListUsers requests and continue to iterate through the users field on the corresponding responses.

All the usual ListUsersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

The abstract base class for a message.

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

A time based retention policy specifies that all backups within a certain time period should be retained.

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.

The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the start_times field to have one element "22:00" and the days_of_week field to have all seven days of the week.

Message describing Backup object

The abstract base class for a message.

The abstract base class for a message.

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

Backup State

The abstract base class for a message.

Backup Type

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.

State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.

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

The abstract base class for a message.

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

Message for creating batches of instances in a cluster.

The source CloudSQL backup resource.

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

The abstract base class for a message.

Type of Cluster

The abstract base class for a message.

Metadata related to network configuration.

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.

PscConfig contains PSC related configuration at a cluster level.

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

Cluster State

The abstract base class for a message.

Contains information and all metadata related to TRIAL clusters.

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

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.

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.

Possible encryption types.

Any additional metadata information regarding the execution of the SQL

Status contains all valid Status a SQL execution can end up in.

Request for ExecuteSql rpc.

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

Execute a SQL statement response.

Message for triggering failover on an Instance

Cluster level configuration parameters related to the Gemini in Databases add-on.

Instance level configuration parameters related to the Gemini in Databases add-on.

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

FaultType contains all valid types of faults that can be injected to 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.

The abstract base class for a message.

The Availability type of an instance. Potential values:

• ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
• REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Client connection configuration

The abstract base class for a message.

Metadata related to instance-level network configuration.

AuthorizedNetwork contains metadata for an authorized network.

Type of an Instance

    -  Read pool of size 1 can only have zonal availability.
    -  Read pools with node count of 2 or more can have regional
       availability (nodes are present in 2 or more zones in a
       region).
SECONDARY (3):
    SECONDARY instances support read operations
    only. SECONDARY instance is a cross-region read
    replica

The abstract base class for a message.

MachineConfig describes the configuration of a machine.

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

Observability Instance specific configuration.

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

PscInstanceConfig contains PSC related configuration at an instance level.

QueryInsights Instance specific configuration.

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

Configuration for a read pool instance.

Instance State

Policy to be used while updating the instance.

Specifies the available modes of update.

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

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

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.

MaintenanceUpdatePolicy defines the policy for system updates.

MaintenanceWindow specifies a preferred day and time for maintenance.

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

Denote the type of migration source that created this cluster.

Represents the metadata of the long-running operation.

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 promoting a Cluster

Message for current status of the database during Promote Cluster operation.

State contains all valid states of the database during promote cluster operation. This is used for status reporting through the LRO metadata.

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

SqlResult represents the result for the execution of a sql statement.

Contains the name and datatype of a column in a SQL Result.

A single row from a sql result.

A single value in a row from a sql result.

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

SSL configuration.

Certificate Authority (CA) source for SSL/TLS certificates.

SSL mode options.

Subscription_type added to distinguish between Standard and Trial subscriptions. By default, a subscription type is considered STANDARD unless explicitly specified.

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

Restrictions on INTEGER type values.

Restrictions on STRING type values

ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14".

Message for switching over to a cluster

Message for updating a Backup

Message for updating a Cluster

Message for updating a Instance

Message for updating a User

Upgrades a cluster.

UpgradeClusterResponse contains the response for upgrade cluster operation.

Upgrade details of a cluster. This cluster can be primary or secondary.

Details regarding the upgrade of instaces associated with a cluster.

Stage in the upgrade.

Stage information for different stages in the upgrade process.

Status of upgrade operation.

Message for current status of the Major Version Upgrade operation.

Read pool instances upgrade specific status.

Upgrade stats for read pool instances.

Status of an upgrade stage.

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

Message describing User object.

Enum that details the user type.

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

API documentation for alloydb_v1.services.alloy_db_admin.pagers module.

API documentation for alloydb_v1alpha.services.alloy_db_admin.pagers module.

API documentation for alloydb_v1beta.services.alloy_db_admin.pagers module.