AlloyDB v1 API - Namespace Google.Cloud.AlloyDb.V1 (1.8.0)

Classes

AlloyDBAdmin

Service describing handlers for resources

AlloyDBAdmin.AlloyDBAdminBase

Base class for server-side implementations of AlloyDBAdmin

AlloyDBAdmin.AlloyDBAdminClient

Client for AlloyDBAdmin

AlloyDBAdminClient

AlloyDBAdmin client wrapper, for convenient use.

AlloyDBAdminClientBuilder

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

AlloyDBAdminClientImpl

AlloyDBAdmin client wrapper implementation, for convenient use.

AlloyDBAdminSettings

Settings for AlloyDBAdminClient instances.

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.

AutomatedBackupPolicy.Types

Container for nested types declared in the AutomatedBackupPolicy message type.

AutomatedBackupPolicy.Types.QuantityBasedRetention

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

AutomatedBackupPolicy.Types.TimeBasedRetention

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

AutomatedBackupPolicy.Types.WeeklySchedule

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.

Backup

Message describing Backup object

Backup.Types

Container for nested types declared in the Backup message type.

Backup.Types.QuantityBasedExpiry

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)

BackupName

Resource name for the Backup resource.

BackupSource

Message describing a BackupSource.

BatchCreateInstanceStatus

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:

Instance1 = ROLLED_BACK
Instance2 = ROLLED_BACK
Instance3 = FAILED
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.

BatchCreateInstanceStatus.Types

Container for nested types declared in the BatchCreateInstanceStatus message type.

BatchCreateInstancesMetadata

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

BatchCreateInstancesRequest

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

BatchCreateInstancesResponse

Message for creating batches of instances in a cluster.

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.

Cluster.Types

Container for nested types declared in the Cluster message type.

Cluster.Types.NetworkConfig

Metadata related to network configuration.

Cluster.Types.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.

Cluster.Types.SecondaryConfig

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

ClusterName

Resource name for the Cluster resource.

ConnectionInfo

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

ConnectionInfoName

Resource name for the ConnectionInfo resource.

ContinuousBackupConfig

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

ContinuousBackupInfo

ContinuousBackupInfo describes the continuous backup properties of a cluster.

ContinuousBackupSource

Message describing a ContinuousBackupSource.

CreateBackupRequest

Message for creating a Backup

CreateClusterRequest

Message for creating a Cluster

CreateInstanceRequest

Message for creating a Instance

CreateInstanceRequests

See usage below for notes.

CreateSecondaryClusterRequest

CreateSecondaryInstanceRequest

Message for creating a Secondary Instance

CreateUserRequest

Message for creating a User

CryptoKeyVersionName

Resource name for the CryptoKeyVersion resource.

DeleteBackupRequest

Message for deleting a Backup

DeleteClusterRequest

Message for deleting a Cluster

DeleteInstanceRequest

Message for deleting a Instance

DeleteUserRequest

Message for deleting a User

EncryptionConfig

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

EncryptionInfo

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

EncryptionInfo.Types

Container for nested types declared in the EncryptionInfo message type.

FailoverInstanceRequest

Message for triggering failover on an Instance

GenerateClientCertificateRequest

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

GenerateClientCertificateResponse

Message returned by a GenerateClientCertificate operation.

GetBackupRequest

Message for getting a Backup

GetClusterRequest

Message for getting a Cluster

GetConnectionInfoRequest

Request message for GetConnectionInfo.

GetInstanceRequest

Message for getting a Instance

GetUserRequest

Message for getting a User

InjectFaultRequest

Message for triggering fault injection on an instance

InjectFaultRequest.Types

Container for nested types declared in the InjectFaultRequest message type.

Instance

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

Instance.Types

Container for nested types declared in the Instance message type.

Instance.Types.ClientConnectionConfig

Client connection configuration

Instance.Types.MachineConfig

MachineConfig describes the configuration of a machine.

Instance.Types.Node

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.

Instance.Types.QueryInsightsInstanceConfig

QueryInsights Instance specific configuration.

Instance.Types.ReadPoolConfig

Configuration for a read pool instance.

InstanceName

Resource name for the Instance resource.

ListBackupsRequest

Message for requesting list of Backups

ListBackupsResponse

Message for response to listing Backups

ListClustersRequest

Message for requesting list of Clusters

ListClustersResponse

Message for response to listing Clusters

ListInstancesRequest

Message for requesting list of Instances

ListInstancesResponse

Message for response to listing Instances

ListSupportedDatabaseFlagsRequest

Message for listing the information about the supported Database flags.

ListSupportedDatabaseFlagsResponse

Message for response to listing SupportedDatabaseFlags.

ListUsersRequest

Message for requesting list of Users

ListUsersResponse

Message for response to listing Users

MigrationSource

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

MigrationSource.Types

Container for nested types declared in the MigrationSource message type.

NetworkName

Resource name for the Network resource.

OperationMetadata

Represents the metadata of the long-running operation.

PromoteClusterRequest

Message for promoting a Cluster

RestartInstanceRequest

RestoreClusterRequest

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

SslConfig

SSL configuration.

SslConfig.Types

Container for nested types declared in the SslConfig message type.

SupportedDatabaseFlag

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.

SupportedDatabaseFlag.Types

Container for nested types declared in the SupportedDatabaseFlag message type.

SupportedDatabaseFlag.Types.IntegerRestrictions

Restrictions on INTEGER type values.

SupportedDatabaseFlag.Types.StringRestrictions

Restrictions on STRING type values

SupportedDatabaseFlagName

Resource name for the SupportedDatabaseFlag resource.

UpdateBackupRequest

Message for updating a Backup

UpdateClusterRequest

Message for updating a Cluster

UpdateInstanceRequest

Message for updating a Instance

UpdateUserRequest

Message for updating a User

User

Message describing User object.

User.Types

Container for nested types declared in the User message type.

UserName

Resource name for the User resource.

UserPassword

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

Enums

AutomatedBackupPolicy.RetentionOneofCase

Enum of possible cases for the "retention" oneof.

AutomatedBackupPolicy.ScheduleOneofCase

Enum of possible cases for the "schedule" oneof.

Backup.Types.State

Backup State

Backup.Types.Type

Backup Type

BackupName.ResourceNameType

The possible contents of BackupName.

BatchCreateInstanceStatus.Types.State

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

Cluster.SourceOneofCase

Enum of possible cases for the "source" oneof.

Cluster.Types.ClusterType

Type of Cluster

Cluster.Types.State

Cluster State

ClusterName.ResourceNameType

The possible contents of ClusterName.

ClusterView

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

ConnectionInfoName.ResourceNameType

The possible contents of ConnectionInfoName.

CryptoKeyVersionName.ResourceNameType

The possible contents of CryptoKeyVersionName.

DatabaseVersion

The supported database engine versions.

EncryptionInfo.Types.Type

Possible encryption types.

InjectFaultRequest.Types.FaultType

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

Instance.Types.AvailabilityType

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