A client to AlloyDB API
The interfaces provided are listed below, along with usage samples.
AlloyDBAdminClient
Service Description: Service describing handlers for resources
Sample for AlloyDBAdminClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Cluster response = alloyDBAdminClient.getCluster(name);
}
Classes
AlloyDBAdminClient
Service Description: Service describing handlers for resources
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Cluster response = alloyDBAdminClient.getCluster(name);
}
Note: close() needs to be called on the AlloyDBAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AlloyDBAdminSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings =
AlloyDBAdminSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings =
AlloyDBAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings = AlloyDBAdminSettings.newHttpJsonBuilder().build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AlloyDBAdminClient.ListBackupsFixedSizeCollection
AlloyDBAdminClient.ListBackupsPage
AlloyDBAdminClient.ListBackupsPagedResponse
AlloyDBAdminClient.ListClustersFixedSizeCollection
AlloyDBAdminClient.ListClustersPage
AlloyDBAdminClient.ListClustersPagedResponse
AlloyDBAdminClient.ListInstancesFixedSizeCollection
AlloyDBAdminClient.ListInstancesPage
AlloyDBAdminClient.ListInstancesPagedResponse
AlloyDBAdminClient.ListLocationsFixedSizeCollection
AlloyDBAdminClient.ListLocationsPage
AlloyDBAdminClient.ListLocationsPagedResponse
AlloyDBAdminClient.ListSupportedDatabaseFlagsFixedSizeCollection
AlloyDBAdminClient.ListSupportedDatabaseFlagsPage
AlloyDBAdminClient.ListSupportedDatabaseFlagsPagedResponse
AlloyDBAdminClient.ListUsersFixedSizeCollection
AlloyDBAdminClient.ListUsersPage
AlloyDBAdminClient.ListUsersPagedResponse
AlloyDBAdminGrpc
Service describing handlers for resources
AlloyDBAdminGrpc.AlloyDBAdminBlockingStub
A stub to allow clients to do synchronous rpc calls to service AlloyDBAdmin.
Service describing handlers for resources
AlloyDBAdminGrpc.AlloyDBAdminFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service AlloyDBAdmin.
Service describing handlers for resources
AlloyDBAdminGrpc.AlloyDBAdminImplBase
Base class for the server implementation of the service AlloyDBAdmin.
Service describing handlers for resources
AlloyDBAdminGrpc.AlloyDBAdminStub
A stub to allow clients to do asynchronous rpc calls to service AlloyDBAdmin.
Service describing handlers for resources
AlloyDBAdminSettings
Settings class to configure an instance of AlloyDBAdminClient.
The default instance has everything set to sensible defaults:
- The default service address (alloydb.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getCluster to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings.Builder alloyDBAdminSettingsBuilder = AlloyDBAdminSettings.newBuilder();
alloyDBAdminSettingsBuilder
.getClusterSettings()
.setRetrySettings(
alloyDBAdminSettingsBuilder
.getClusterSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AlloyDBAdminSettings alloyDBAdminSettings = alloyDBAdminSettingsBuilder.build();
AlloyDBAdminSettings.Builder
Builder for AlloyDBAdminSettings.
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.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy
AutomatedBackupPolicy.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy
AutomatedBackupPolicy.QuantityBasedRetention
A quantity based policy specifies that a certain number of the most recent successful backups should be retained.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy.QuantityBasedRetention
AutomatedBackupPolicy.QuantityBasedRetention.Builder
A quantity based policy specifies that a certain number of the most recent successful backups should be retained.
Protobuf type
google.cloud.alloydb.v1beta.AutomatedBackupPolicy.QuantityBasedRetention
AutomatedBackupPolicy.TimeBasedRetention
A time based retention policy specifies that all backups within a certain time period should be retained.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy.TimeBasedRetention
AutomatedBackupPolicy.TimeBasedRetention.Builder
A time based retention policy specifies that all backups within a certain time period should be retained.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy.TimeBasedRetention
AutomatedBackupPolicy.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.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy.WeeklySchedule
AutomatedBackupPolicy.WeeklySchedule.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.AutomatedBackupPolicy.WeeklySchedule
Backup
Message describing Backup object
Protobuf type google.cloud.alloydb.v1beta.Backup
Backup.Builder
Message describing Backup object
Protobuf type google.cloud.alloydb.v1beta.Backup
Backup.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)
Protobuf type google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry
Backup.QuantityBasedExpiry.Builder
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)
Protobuf type google.cloud.alloydb.v1beta.Backup.QuantityBasedExpiry
BackupName
BackupName.Builder
Builder for projects/{project}/locations/{location}/backups/{backup}.
BackupSource
Message describing a BackupSource.
Protobuf type google.cloud.alloydb.v1beta.BackupSource
BackupSource.Builder
Message describing a BackupSource.
Protobuf type google.cloud.alloydb.v1beta.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.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstanceStatus
BatchCreateInstanceStatus.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstanceStatus
BatchCreateInstancesMetadata
Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesMetadata
BatchCreateInstancesMetadata.Builder
Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesMetadata
BatchCreateInstancesRequest
Message for creating a batch of instances under the specified cluster.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesRequest
BatchCreateInstancesRequest.Builder
Message for creating a batch of instances under the specified cluster.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesRequest
BatchCreateInstancesResponse
Message for creating batches of instances in a cluster.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesResponse
BatchCreateInstancesResponse.Builder
Message for creating batches of instances in a cluster.
Protobuf type google.cloud.alloydb.v1beta.BatchCreateInstancesResponse
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.
Protobuf type google.cloud.alloydb.v1beta.Cluster
Cluster.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.Cluster
Cluster.NetworkConfig
Metadata related to network configuration.
Protobuf type google.cloud.alloydb.v1beta.Cluster.NetworkConfig
Cluster.NetworkConfig.Builder
Metadata related to network configuration.
Protobuf type google.cloud.alloydb.v1beta.Cluster.NetworkConfig
Cluster.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.
Protobuf type google.cloud.alloydb.v1beta.Cluster.PrimaryConfig
Cluster.PrimaryConfig.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.Cluster.PrimaryConfig
Cluster.SecondaryConfig
Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
Protobuf type google.cloud.alloydb.v1beta.Cluster.SecondaryConfig
Cluster.SecondaryConfig.Builder
Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
Protobuf type google.cloud.alloydb.v1beta.Cluster.SecondaryConfig
ClusterName
ClusterName.Builder
Builder for projects/{project}/locations/{location}/clusters/{cluster}.
ConnectionInfo
ConnectionInfo singleton resource. https://google.aip.dev/156
Protobuf type google.cloud.alloydb.v1beta.ConnectionInfo
ConnectionInfo.Builder
ConnectionInfo singleton resource. https://google.aip.dev/156
Protobuf type google.cloud.alloydb.v1beta.ConnectionInfo
ContinuousBackupConfig
ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupConfig
ContinuousBackupConfig.Builder
ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupConfig
ContinuousBackupInfo
ContinuousBackupInfo describes the continuous backup properties of a cluster.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupInfo
ContinuousBackupInfo.Builder
ContinuousBackupInfo describes the continuous backup properties of a cluster.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupInfo
ContinuousBackupSource
Message describing a ContinuousBackupSource.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupSource
ContinuousBackupSource.Builder
Message describing a ContinuousBackupSource.
Protobuf type google.cloud.alloydb.v1beta.ContinuousBackupSource
CreateBackupRequest
Message for creating a Backup
Protobuf type google.cloud.alloydb.v1beta.CreateBackupRequest
CreateBackupRequest.Builder
Message for creating a Backup
Protobuf type google.cloud.alloydb.v1beta.CreateBackupRequest
CreateClusterRequest
Message for creating a Cluster
Protobuf type google.cloud.alloydb.v1beta.CreateClusterRequest
CreateClusterRequest.Builder
Message for creating a Cluster
Protobuf type google.cloud.alloydb.v1beta.CreateClusterRequest
CreateInstanceRequest
Message for creating a Instance
Protobuf type google.cloud.alloydb.v1beta.CreateInstanceRequest
CreateInstanceRequest.Builder
Message for creating a Instance
Protobuf type google.cloud.alloydb.v1beta.CreateInstanceRequest
CreateInstanceRequests
See usage below for notes.
Protobuf type google.cloud.alloydb.v1beta.CreateInstanceRequests
CreateInstanceRequests.Builder
See usage below for notes.
Protobuf type google.cloud.alloydb.v1beta.CreateInstanceRequests
CreateSecondaryClusterRequest
Protobuf type google.cloud.alloydb.v1beta.CreateSecondaryClusterRequest
CreateSecondaryClusterRequest.Builder
Protobuf type google.cloud.alloydb.v1beta.CreateSecondaryClusterRequest
CreateSecondaryInstanceRequest
Message for creating a Secondary Instance
Protobuf type google.cloud.alloydb.v1beta.CreateSecondaryInstanceRequest
CreateSecondaryInstanceRequest.Builder
Message for creating a Secondary Instance
Protobuf type google.cloud.alloydb.v1beta.CreateSecondaryInstanceRequest
CreateUserRequest
Message for creating a User
Protobuf type google.cloud.alloydb.v1beta.CreateUserRequest
CreateUserRequest.Builder
Message for creating a User
Protobuf type google.cloud.alloydb.v1beta.CreateUserRequest
DeleteBackupRequest
Message for deleting a Backup
Protobuf type google.cloud.alloydb.v1beta.DeleteBackupRequest
DeleteBackupRequest.Builder
Message for deleting a Backup
Protobuf type google.cloud.alloydb.v1beta.DeleteBackupRequest
DeleteClusterRequest
Message for deleting a Cluster
Protobuf type google.cloud.alloydb.v1beta.DeleteClusterRequest
DeleteClusterRequest.Builder
Message for deleting a Cluster
Protobuf type google.cloud.alloydb.v1beta.DeleteClusterRequest
DeleteInstanceRequest
Message for deleting a Instance
Protobuf type google.cloud.alloydb.v1beta.DeleteInstanceRequest
DeleteInstanceRequest.Builder
Message for deleting a Instance
Protobuf type google.cloud.alloydb.v1beta.DeleteInstanceRequest
DeleteUserRequest
Message for deleting a User
Protobuf type google.cloud.alloydb.v1beta.DeleteUserRequest
DeleteUserRequest.Builder
Message for deleting a User
Protobuf type google.cloud.alloydb.v1beta.DeleteUserRequest
EncryptionConfig
EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).
Protobuf type google.cloud.alloydb.v1beta.EncryptionConfig
EncryptionConfig.Builder
EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).
Protobuf type google.cloud.alloydb.v1beta.EncryptionConfig
EncryptionInfo
EncryptionInfo describes the encryption information of a cluster or a backup.
Protobuf type google.cloud.alloydb.v1beta.EncryptionInfo
EncryptionInfo.Builder
EncryptionInfo describes the encryption information of a cluster or a backup.
Protobuf type google.cloud.alloydb.v1beta.EncryptionInfo
FailoverInstanceRequest
Message for triggering failover on an Instance
Protobuf type google.cloud.alloydb.v1beta.FailoverInstanceRequest
FailoverInstanceRequest.Builder
Message for triggering failover on an Instance
Protobuf type google.cloud.alloydb.v1beta.FailoverInstanceRequest
GenerateClientCertificateRequest
Message for requests to generate a client certificate signed by the Cluster CA.
Protobuf type google.cloud.alloydb.v1beta.GenerateClientCertificateRequest
GenerateClientCertificateRequest.Builder
Message for requests to generate a client certificate signed by the Cluster CA.
Protobuf type google.cloud.alloydb.v1beta.GenerateClientCertificateRequest
GenerateClientCertificateResponse
Message returned by a GenerateClientCertificate operation.
Protobuf type google.cloud.alloydb.v1beta.GenerateClientCertificateResponse
GenerateClientCertificateResponse.Builder
Message returned by a GenerateClientCertificate operation.
Protobuf type google.cloud.alloydb.v1beta.GenerateClientCertificateResponse
GetBackupRequest
Message for getting a Backup
Protobuf type google.cloud.alloydb.v1beta.GetBackupRequest
GetBackupRequest.Builder
Message for getting a Backup
Protobuf type google.cloud.alloydb.v1beta.GetBackupRequest
GetClusterRequest
Message for getting a Cluster
Protobuf type google.cloud.alloydb.v1beta.GetClusterRequest
GetClusterRequest.Builder
Message for getting a Cluster
Protobuf type google.cloud.alloydb.v1beta.GetClusterRequest
GetConnectionInfoRequest
Request message for GetConnectionInfo.
Protobuf type google.cloud.alloydb.v1beta.GetConnectionInfoRequest
GetConnectionInfoRequest.Builder
Request message for GetConnectionInfo.
Protobuf type google.cloud.alloydb.v1beta.GetConnectionInfoRequest
GetInstanceRequest
Message for getting a Instance
Protobuf type google.cloud.alloydb.v1beta.GetInstanceRequest
GetInstanceRequest.Builder
Message for getting a Instance
Protobuf type google.cloud.alloydb.v1beta.GetInstanceRequest
GetUserRequest
Message for getting a User
Protobuf type google.cloud.alloydb.v1beta.GetUserRequest
GetUserRequest.Builder
Message for getting a User
Protobuf type google.cloud.alloydb.v1beta.GetUserRequest
InjectFaultRequest
Message for triggering fault injection on an instance
Protobuf type google.cloud.alloydb.v1beta.InjectFaultRequest
InjectFaultRequest.Builder
Message for triggering fault injection on an instance
Protobuf type google.cloud.alloydb.v1beta.InjectFaultRequest
Instance
An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
Protobuf type google.cloud.alloydb.v1beta.Instance
Instance.Builder
An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
Protobuf type google.cloud.alloydb.v1beta.Instance
Instance.ClientConnectionConfig
Client connection configuration
Protobuf type google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig
Instance.ClientConnectionConfig.Builder
Client connection configuration
Protobuf type google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig
Instance.MachineConfig
MachineConfig describes the configuration of a machine.
Protobuf type google.cloud.alloydb.v1beta.Instance.MachineConfig
Instance.MachineConfig.Builder
MachineConfig describes the configuration of a machine.
Protobuf type google.cloud.alloydb.v1beta.Instance.MachineConfig
Instance.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.
Protobuf type google.cloud.alloydb.v1beta.Instance.Node
Instance.Node.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.Instance.Node
Instance.QueryInsightsInstanceConfig
QueryInsights Instance specific configuration.
Protobuf type google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig
Instance.QueryInsightsInstanceConfig.Builder
QueryInsights Instance specific configuration.
Protobuf type google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig
Instance.ReadPoolConfig
Configuration for a read pool instance.
Protobuf type google.cloud.alloydb.v1beta.Instance.ReadPoolConfig
Instance.ReadPoolConfig.Builder
Configuration for a read pool instance.
Protobuf type google.cloud.alloydb.v1beta.Instance.ReadPoolConfig
Instance.UpdatePolicy
Policy to be used while updating the instance.
Protobuf type google.cloud.alloydb.v1beta.Instance.UpdatePolicy
Instance.UpdatePolicy.Builder
Policy to be used while updating the instance.
Protobuf type google.cloud.alloydb.v1beta.Instance.UpdatePolicy
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}.
ListBackupsRequest
Message for requesting list of Backups
Protobuf type google.cloud.alloydb.v1beta.ListBackupsRequest
ListBackupsRequest.Builder
Message for requesting list of Backups
Protobuf type google.cloud.alloydb.v1beta.ListBackupsRequest
ListBackupsResponse
Message for response to listing Backups
Protobuf type google.cloud.alloydb.v1beta.ListBackupsResponse
ListBackupsResponse.Builder
Message for response to listing Backups
Protobuf type google.cloud.alloydb.v1beta.ListBackupsResponse
ListClustersRequest
Message for requesting list of Clusters
Protobuf type google.cloud.alloydb.v1beta.ListClustersRequest
ListClustersRequest.Builder
Message for requesting list of Clusters
Protobuf type google.cloud.alloydb.v1beta.ListClustersRequest
ListClustersResponse
Message for response to listing Clusters
Protobuf type google.cloud.alloydb.v1beta.ListClustersResponse
ListClustersResponse.Builder
Message for response to listing Clusters
Protobuf type google.cloud.alloydb.v1beta.ListClustersResponse
ListInstancesRequest
Message for requesting list of Instances
Protobuf type google.cloud.alloydb.v1beta.ListInstancesRequest
ListInstancesRequest.Builder
Message for requesting list of Instances
Protobuf type google.cloud.alloydb.v1beta.ListInstancesRequest
ListInstancesResponse
Message for response to listing Instances
Protobuf type google.cloud.alloydb.v1beta.ListInstancesResponse
ListInstancesResponse.Builder
Message for response to listing Instances
Protobuf type google.cloud.alloydb.v1beta.ListInstancesResponse
ListSupportedDatabaseFlagsRequest
Message for listing the information about the supported Database flags.
Protobuf type google.cloud.alloydb.v1beta.ListSupportedDatabaseFlagsRequest
ListSupportedDatabaseFlagsRequest.Builder
Message for listing the information about the supported Database flags.
Protobuf type google.cloud.alloydb.v1beta.ListSupportedDatabaseFlagsRequest
ListSupportedDatabaseFlagsResponse
Message for response to listing SupportedDatabaseFlags.
Protobuf type google.cloud.alloydb.v1beta.ListSupportedDatabaseFlagsResponse
ListSupportedDatabaseFlagsResponse.Builder
Message for response to listing SupportedDatabaseFlags.
Protobuf type google.cloud.alloydb.v1beta.ListSupportedDatabaseFlagsResponse
ListUsersRequest
Message for requesting list of Users
Protobuf type google.cloud.alloydb.v1beta.ListUsersRequest
ListUsersRequest.Builder
Message for requesting list of Users
Protobuf type google.cloud.alloydb.v1beta.ListUsersRequest
ListUsersResponse
Message for response to listing Users
Protobuf type google.cloud.alloydb.v1beta.ListUsersResponse
ListUsersResponse.Builder
Message for response to listing Users
Protobuf type google.cloud.alloydb.v1beta.ListUsersResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
MigrationSource
Subset of the source instance configuration that is available when reading the cluster resource.
Protobuf type google.cloud.alloydb.v1beta.MigrationSource
MigrationSource.Builder
Subset of the source instance configuration that is available when reading the cluster resource.
Protobuf type google.cloud.alloydb.v1beta.MigrationSource
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.alloydb.v1beta.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.alloydb.v1beta.OperationMetadata
PromoteClusterRequest
Message for promoting a Cluster
Protobuf type google.cloud.alloydb.v1beta.PromoteClusterRequest
PromoteClusterRequest.Builder
Message for promoting a Cluster
Protobuf type google.cloud.alloydb.v1beta.PromoteClusterRequest
ResourcesProto
RestartInstanceRequest
Protobuf type google.cloud.alloydb.v1beta.RestartInstanceRequest
RestartInstanceRequest.Builder
Protobuf type google.cloud.alloydb.v1beta.RestartInstanceRequest
RestoreClusterRequest
Message for restoring a Cluster from a backup or another cluster at a given point in time.
Protobuf type google.cloud.alloydb.v1beta.RestoreClusterRequest
RestoreClusterRequest.Builder
Message for restoring a Cluster from a backup or another cluster at a given point in time.
Protobuf type google.cloud.alloydb.v1beta.RestoreClusterRequest
ServiceProto
SslConfig
SSL configuration.
Protobuf type google.cloud.alloydb.v1beta.SslConfig
SslConfig.Builder
SSL configuration.
Protobuf type google.cloud.alloydb.v1beta.SslConfig
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.
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag
SupportedDatabaseFlag.Builder
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.
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag
SupportedDatabaseFlag.IntegerRestrictions
Restrictions on INTEGER type values.
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag.IntegerRestrictions
SupportedDatabaseFlag.IntegerRestrictions.Builder
Restrictions on INTEGER type values.
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag.IntegerRestrictions
SupportedDatabaseFlag.StringRestrictions
Restrictions on STRING type values
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag.StringRestrictions
SupportedDatabaseFlag.StringRestrictions.Builder
Restrictions on STRING type values
Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag.StringRestrictions
SupportedDatabaseFlagName
SupportedDatabaseFlagName.Builder
Builder for projects/{project}/locations/{location}/flags/{flag}.
UpdateBackupRequest
Message for updating a Backup
Protobuf type google.cloud.alloydb.v1beta.UpdateBackupRequest
UpdateBackupRequest.Builder
Message for updating a Backup
Protobuf type google.cloud.alloydb.v1beta.UpdateBackupRequest
UpdateClusterRequest
Message for updating a Cluster
Protobuf type google.cloud.alloydb.v1beta.UpdateClusterRequest
UpdateClusterRequest.Builder
Message for updating a Cluster
Protobuf type google.cloud.alloydb.v1beta.UpdateClusterRequest
UpdateInstanceRequest
Message for updating a Instance
Protobuf type google.cloud.alloydb.v1beta.UpdateInstanceRequest
UpdateInstanceRequest.Builder
Message for updating a Instance
Protobuf type google.cloud.alloydb.v1beta.UpdateInstanceRequest
UpdateUserRequest
Message for updating a User
Protobuf type google.cloud.alloydb.v1beta.UpdateUserRequest
UpdateUserRequest.Builder
Message for updating a User
Protobuf type google.cloud.alloydb.v1beta.UpdateUserRequest
User
Message describing User object.
Protobuf type google.cloud.alloydb.v1beta.User
User.Builder
Message describing User object.
Protobuf type google.cloud.alloydb.v1beta.User
UserName
UserName.Builder
Builder for projects/{project}/locations/{location}/clusters/{cluster}/users/{user}.
UserPassword
The username/password for a database user. Used for specifying initial users at cluster creation time.
Protobuf type google.cloud.alloydb.v1beta.UserPassword
UserPassword.Builder
The username/password for a database user. Used for specifying initial users at cluster creation time.
Protobuf type google.cloud.alloydb.v1beta.UserPassword
Interfaces
AlloyDBAdminGrpc.AsyncService
Service describing handlers for resources
AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder
AutomatedBackupPolicy.TimeBasedRetentionOrBuilder
AutomatedBackupPolicy.WeeklyScheduleOrBuilder
AutomatedBackupPolicyOrBuilder
Backup.QuantityBasedExpiryOrBuilder
BackupOrBuilder
BackupSourceOrBuilder
BatchCreateInstanceStatusOrBuilder
BatchCreateInstancesMetadataOrBuilder
BatchCreateInstancesRequestOrBuilder
BatchCreateInstancesResponseOrBuilder
Cluster.NetworkConfigOrBuilder
Cluster.PrimaryConfigOrBuilder
Cluster.SecondaryConfigOrBuilder
ClusterOrBuilder
ConnectionInfoOrBuilder
ContinuousBackupConfigOrBuilder
ContinuousBackupInfoOrBuilder
ContinuousBackupSourceOrBuilder
CreateBackupRequestOrBuilder
CreateClusterRequestOrBuilder
CreateInstanceRequestOrBuilder
CreateInstanceRequestsOrBuilder
CreateSecondaryClusterRequestOrBuilder
CreateSecondaryInstanceRequestOrBuilder
CreateUserRequestOrBuilder
DeleteBackupRequestOrBuilder
DeleteClusterRequestOrBuilder
DeleteInstanceRequestOrBuilder
DeleteUserRequestOrBuilder
EncryptionConfigOrBuilder
EncryptionInfoOrBuilder
FailoverInstanceRequestOrBuilder
GenerateClientCertificateRequestOrBuilder
GenerateClientCertificateResponseOrBuilder
GetBackupRequestOrBuilder
GetClusterRequestOrBuilder
GetConnectionInfoRequestOrBuilder
GetInstanceRequestOrBuilder
GetUserRequestOrBuilder
InjectFaultRequestOrBuilder
Instance.ClientConnectionConfigOrBuilder
Instance.MachineConfigOrBuilder
Instance.NodeOrBuilder
Instance.QueryInsightsInstanceConfigOrBuilder
Instance.ReadPoolConfigOrBuilder
Instance.UpdatePolicyOrBuilder
InstanceOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListClustersRequestOrBuilder
ListClustersResponseOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
ListSupportedDatabaseFlagsRequestOrBuilder
ListSupportedDatabaseFlagsResponseOrBuilder
ListUsersRequestOrBuilder
ListUsersResponseOrBuilder
MigrationSourceOrBuilder
OperationMetadataOrBuilder
PromoteClusterRequestOrBuilder
RestartInstanceRequestOrBuilder
RestoreClusterRequestOrBuilder
SslConfigOrBuilder
SupportedDatabaseFlag.IntegerRestrictionsOrBuilder
SupportedDatabaseFlag.StringRestrictionsOrBuilder
SupportedDatabaseFlagOrBuilder
UpdateBackupRequestOrBuilder
UpdateClusterRequestOrBuilder
UpdateInstanceRequestOrBuilder
UpdateUserRequestOrBuilder
UserOrBuilder
UserPasswordOrBuilder
Enums
AutomatedBackupPolicy.RetentionCase
AutomatedBackupPolicy.ScheduleCase
Backup.State
Backup State
Protobuf enum google.cloud.alloydb.v1beta.Backup.State
Backup.Type
Backup Type
Protobuf enum google.cloud.alloydb.v1beta.Backup.Type
BatchCreateInstanceStatus.State
State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.
Protobuf enum google.cloud.alloydb.v1beta.BatchCreateInstanceStatus.State
Cluster.ClusterType
Type of Cluster
Protobuf enum google.cloud.alloydb.v1beta.Cluster.ClusterType
Cluster.SourceCase
Cluster.State
Cluster State
Protobuf enum google.cloud.alloydb.v1beta.Cluster.State
ClusterView
View on Cluster. Pass this enum to rpcs that returns a cluster message to control which subsets of fields to get.
Protobuf enum google.cloud.alloydb.v1beta.ClusterView
DatabaseVersion
The supported database engine versions.
Protobuf enum google.cloud.alloydb.v1beta.DatabaseVersion
EncryptionInfo.Type
Possible encryption types.
Protobuf enum google.cloud.alloydb.v1beta.EncryptionInfo.Type
InjectFaultRequest.FaultType
FaultType contains all valid types of faults that can be injected to an instance.
Protobuf enum google.cloud.alloydb.v1beta.InjectFaultRequest.FaultType
Instance.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).
Protobuf enum google.cloud.alloydb.v1beta.Instance.AvailabilityType
Instance.InstanceType
Type of an Instance
Protobuf enum google.cloud.alloydb.v1beta.Instance.InstanceType
Instance.State
Instance State
Protobuf enum google.cloud.alloydb.v1beta.Instance.State
Instance.UpdatePolicy.Mode
Specifies the available modes of update.
Protobuf enum google.cloud.alloydb.v1beta.Instance.UpdatePolicy.Mode
InstanceView
View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.
Protobuf enum google.cloud.alloydb.v1beta.InstanceView
MigrationSource.MigrationSourceType
Denote the type of migration source that created this cluster.
Protobuf enum google.cloud.alloydb.v1beta.MigrationSource.MigrationSourceType
OperationMetadata.RequestSpecificCase
RestoreClusterRequest.SourceCase
SslConfig.CaSource
Certificate Authority (CA) source for SSL/TLS certificates.
Protobuf enum google.cloud.alloydb.v1beta.SslConfig.CaSource
SslConfig.SslMode
SSL mode options.
Protobuf enum google.cloud.alloydb.v1beta.SslConfig.SslMode
SupportedDatabaseFlag.RestrictionsCase
SupportedDatabaseFlag.ValueType
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".
Protobuf enum google.cloud.alloydb.v1beta.SupportedDatabaseFlag.ValueType
User.UserType
Enum that details the user type.
Protobuf enum google.cloud.alloydb.v1beta.User.UserType