AlloyDB v1alpha API - Namespace Google.Cloud.AlloyDb.V1Alpha (1.0.0-alpha08)

Service describing handlers for resources

Base class for server-side implementations of AlloyDBAdmin

Client for AlloyDBAdmin

AlloyDBAdmin client wrapper, for convenient use.

Builder class for AlloyDBAdminClient to provide simple configuration of credentials, endpoint etc.

AlloyDBAdmin client wrapper implementation, for convenient use.

Settings for AlloyDBAdminClient instances.

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.

Container for nested types declared in the AutomatedBackupPolicy message type.

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

Container for nested types declared in the Backup message type.

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)

Resource name for the Backup resource.

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.

Container for nested types declared in the BatchCreateInstanceStatus message type.

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.

Container for nested types declared in the Cluster message type.

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.

Resource name for the Cluster resource.

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

Resource name for the ConnectionInfo resource.

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

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

Resource name for the CryptoKeyVersion resource.

Message describing Database object.

Resource name for the Database resource.

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.

Container for nested types declared in the EncryptionInfo message type.

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

Container for nested types declared in the InjectFaultRequest message type.

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

Container for nested types declared in the Instance message type.

Client connection configuration

Metadata related to instance level network configuration.

Container for nested types declared in the InstanceNetworkConfig message type.

AuthorizedNetwork contains metadata for an authorized network.

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.

Configuration for setting up a PSC interface. This information needs to be provided by the customer. PSC interfaces will be created and added to VMs via SLM (adding a network interface will require recreating the VM). For HA instances this will be done via LDTM.

QueryInsights Instance specific configuration.

Configuration for a read pool instance.

Policy to be used while updating the instance.

Container for nested types declared in the UpdatePolicy message type.

Resource name for the Instance resource.

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.

Container for nested types declared in the MigrationSource message type.

Resource name for the Network resource.

Represents the metadata of the long-running operation.

Message for promoting a Cluster

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

SSL configuration.

Container for nested types declared in the SslConfig message type.

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.

Container for nested types declared in the SupportedDatabaseFlag message type.

Restrictions on INTEGER type values.

Restrictions on STRING type values

Resource name for the SupportedDatabaseFlag resource.

Message for updating a Backup

Message for updating a Cluster

Message for updating a Instance

Message for updating a User

Message describing User object.

Container for nested types declared in the User message type.

Resource name for the User resource.

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

Enum of possible cases for the "retention" oneof.

Enum of possible cases for the "schedule" oneof.

Backup State

Backup Type

The possible contents of BackupName.

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

Enum of possible cases for the "source" oneof.

Type of Cluster

Cluster State

The possible contents of ClusterName.

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

The possible contents of ConnectionInfoName.

The possible contents of CryptoKeyVersionName.

The possible contents of DatabaseName.

The supported database engine versions.

Possible encryption types.

FaultType contains all valid types of faults that can be injected to an instance.

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

Type of an Instance

Instance State

Specifies the available modes of update.

The possible contents of InstanceName.

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

Denote the type of migration source that created this cluster.

The possible contents of NetworkName.

Enum of possible cases for the "request_specific" oneof.

Enum of possible cases for the "source" oneof.

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

SSL mode options.

Enum of possible cases for the "restrictions" oneof.

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".

The possible contents of SupportedDatabaseFlagName.

Enum that details the user type.

The possible contents of UserName.