@Generated("by gapic-generator-java")
Package com.google.cloud.alloydb.v1
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);
}
-
Class Summary Class Description AlloyDBAdminClient Service Description: Service describing handlers for resourcesAlloyDBAdminClient.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 resourcesAlloyDBAdminGrpc.AlloyDBAdminBlockingStub A stub to allow clients to do synchronous rpc calls to service AlloyDBAdmin.AlloyDBAdminGrpc.AlloyDBAdminFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service AlloyDBAdmin.AlloyDBAdminGrpc.AlloyDBAdminImplBase Base class for the server implementation of the service AlloyDBAdmin.AlloyDBAdminGrpc.AlloyDBAdminStub A stub to allow clients to do asynchronous rpc calls to service AlloyDBAdmin.AlloyDBAdminSettings Settings class to configure an instance ofAlloyDBAdminClient
.AlloyDBAdminSettings.Builder Builder for AlloyDBAdminSettings.AutomatedBackupPolicy Message describing the user-specified automated backup policy.AutomatedBackupPolicy.Builder Message describing the user-specified automated backup policy.AutomatedBackupPolicy.QuantityBasedRetention A quantity based policy specifies that a certain number of the most recent successful backups should be retained.AutomatedBackupPolicy.QuantityBasedRetention.Builder A quantity based policy specifies that a certain number of the most recent successful backups should be retained.AutomatedBackupPolicy.TimeBasedRetention A time based retention policy specifies that all backups within a certain time period should be retained.AutomatedBackupPolicy.TimeBasedRetention.Builder A time based retention policy specifies that all backups within a certain time period should be retained.AutomatedBackupPolicy.WeeklySchedule A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.AutomatedBackupPolicy.WeeklySchedule.Builder A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.Backup Message describing Backup objectBackup.Builder Message describing Backup objectBackupName BackupName.Builder Builder for projects/{project}/locations/{location}/backups/{backup}.BackupSource Message describing a BackupSource.BackupSource.Builder Message describing a BackupSource.BatchCreateInstancesMetadata Message for metadata that is specific to BatchCreateInstances API.BatchCreateInstancesMetadata.Builder Message for metadata that is specific to BatchCreateInstances API.BatchCreateInstancesRequest Message for creating a batch of instances under the specified cluster.BatchCreateInstancesRequest.Builder Message for creating a batch of instances under the specified cluster.BatchCreateInstancesResponse Message for creating batches of instances in a cluster.BatchCreateInstancesResponse.Builder Message for creating batches of instances in a cluster.BatchCreateInstanceStatus Message for current status of an instance in the BatchCreateInstances operation.BatchCreateInstanceStatus.Builder Message for current status of an instance in the BatchCreateInstances operation.Cluster A cluster is a collection of regional AlloyDB resources.Cluster.Builder A cluster is a collection of regional AlloyDB resources.Cluster.PrimaryConfig Configuration for the primary cluster.Cluster.PrimaryConfig.Builder Configuration for the primary cluster.Cluster.SecondaryConfig Configuration information for the secondary cluster.Cluster.SecondaryConfig.Builder Configuration information for the secondary cluster.ClusterName ClusterName.Builder Builder for projects/{project}/locations/{location}/clusters/{cluster}.ContinuousBackupConfig ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.ContinuousBackupConfig.Builder ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.ContinuousBackupInfo ContinuousBackupInfo describes the continuous backup properties of a cluster.ContinuousBackupInfo.Builder ContinuousBackupInfo describes the continuous backup properties of a cluster.ContinuousBackupSource Message describing a ContinuousBackupSource.ContinuousBackupSource.Builder Message describing a ContinuousBackupSource.CreateBackupRequest Message for creating a BackupCreateBackupRequest.Builder Message for creating a BackupCreateClusterRequest Message for creating a ClusterCreateClusterRequest.Builder Message for creating a ClusterCreateInstanceRequest Message for creating a InstanceCreateInstanceRequest.Builder Message for creating a InstanceCreateInstanceRequests See usage below for notes.CreateInstanceRequests.Builder See usage below for notes.CreateSecondaryClusterRequest Protobuf typegoogle.cloud.alloydb.v1.CreateSecondaryClusterRequest
CreateSecondaryClusterRequest.Builder Protobuf typegoogle.cloud.alloydb.v1.CreateSecondaryClusterRequest
CreateSecondaryInstanceRequest Message for creating a Secondary InstanceCreateSecondaryInstanceRequest.Builder Message for creating a Secondary InstanceCreateUserRequest Message for creating a UserCreateUserRequest.Builder Message for creating a UserDeleteBackupRequest Message for deleting a BackupDeleteBackupRequest.Builder Message for deleting a BackupDeleteClusterRequest Message for deleting a ClusterDeleteClusterRequest.Builder Message for deleting a ClusterDeleteInstanceRequest Message for deleting a InstanceDeleteInstanceRequest.Builder Message for deleting a InstanceDeleteUserRequest Message for deleting a UserDeleteUserRequest.Builder Message for deleting a UserEncryptionConfig EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).EncryptionConfig.Builder 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.Builder EncryptionInfo describes the encryption information of a cluster or a backup.FailoverInstanceRequest Message for triggering failover on an InstanceFailoverInstanceRequest.Builder Message for triggering failover on an InstanceGetBackupRequest Message for getting a BackupGetBackupRequest.Builder Message for getting a BackupGetClusterRequest Message for getting a ClusterGetClusterRequest.Builder Message for getting a ClusterGetInstanceRequest Message for getting a InstanceGetInstanceRequest.Builder Message for getting a InstanceGetUserRequest Message for getting a UserGetUserRequest.Builder Message for getting a UserInjectFaultRequest Message for triggering fault injection on an instanceInjectFaultRequest.Builder Message for triggering fault injection on an instanceInstance An Instance is a computing unit that an end customer can connect to.Instance.Builder An Instance is a computing unit that an end customer can connect to.Instance.MachineConfig MachineConfig describes the configuration of a machine.Instance.MachineConfig.Builder MachineConfig describes the configuration of a machine.Instance.Node Details of a single node in the instance.Instance.Node.Builder Details of a single node in the instance.Instance.QueryInsightsInstanceConfig QueryInsights Instance specific configuration.Instance.QueryInsightsInstanceConfig.Builder QueryInsights Instance specific configuration.Instance.ReadPoolConfig Configuration for a read pool instance.Instance.ReadPoolConfig.Builder Configuration for a read pool instance.InstanceName InstanceName.Builder Builder for projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}.ListBackupsRequest Message for requesting list of BackupsListBackupsRequest.Builder Message for requesting list of BackupsListBackupsResponse Message for response to listing BackupsListBackupsResponse.Builder Message for response to listing BackupsListClustersRequest Message for requesting list of ClustersListClustersRequest.Builder Message for requesting list of ClustersListClustersResponse Message for response to listing ClustersListClustersResponse.Builder Message for response to listing ClustersListInstancesRequest Message for requesting list of InstancesListInstancesRequest.Builder Message for requesting list of InstancesListInstancesResponse Message for response to listing InstancesListInstancesResponse.Builder Message for response to listing InstancesListSupportedDatabaseFlagsRequest Message for listing the information about the supported Database flags.ListSupportedDatabaseFlagsRequest.Builder Message for listing the information about the supported Database flags.ListSupportedDatabaseFlagsResponse Message for response to listing SupportedDatabaseFlags.ListSupportedDatabaseFlagsResponse.Builder Message for response to listing SupportedDatabaseFlags.ListUsersRequest Message for requesting list of UsersListUsersRequest.Builder Message for requesting list of UsersListUsersResponse Message for response to listing UsersListUsersResponse.Builder Message for response to listing UsersLocationName LocationName.Builder Builder for projects/{project}/locations/{location}.MigrationSource Subset of the source instance configuration that is available when reading the cluster resource.MigrationSource.Builder Subset of the source instance configuration that is available when reading the cluster resource.OperationMetadata Represents the metadata of the long-running operation.OperationMetadata.Builder Represents the metadata of the long-running operation.PromoteClusterRequest Message for promoting a ClusterPromoteClusterRequest.Builder Message for promoting a ClusterResourcesProto RestartInstanceRequest Protobuf typegoogle.cloud.alloydb.v1.RestartInstanceRequest
RestartInstanceRequest.Builder Protobuf typegoogle.cloud.alloydb.v1.RestartInstanceRequest
RestoreClusterRequest Message for restoring a Cluster from a backup or another cluster at a given point in time.RestoreClusterRequest.Builder Message for restoring a Cluster from a backup or another cluster at a given point in time.ServiceProto SslConfig SSL configuration.SslConfig.Builder SSL configuration.SupportedDatabaseFlag SupportedDatabaseFlag gives general information about a database flag, like type and allowed values.SupportedDatabaseFlag.Builder SupportedDatabaseFlag gives general information about a database flag, like type and allowed values.SupportedDatabaseFlag.IntegerRestrictions Restrictions on INTEGER type values.SupportedDatabaseFlag.IntegerRestrictions.Builder Restrictions on INTEGER type values.SupportedDatabaseFlag.StringRestrictions Restrictions on STRING type valuesSupportedDatabaseFlag.StringRestrictions.Builder Restrictions on STRING type valuesSupportedDatabaseFlagName SupportedDatabaseFlagName.Builder Builder for projects/{project}/locations/{location}/flags/{flag}.UpdateBackupRequest Message for updating a BackupUpdateBackupRequest.Builder Message for updating a BackupUpdateClusterRequest Message for updating a ClusterUpdateClusterRequest.Builder Message for updating a ClusterUpdateInstanceRequest Message for updating a InstanceUpdateInstanceRequest.Builder Message for updating a InstanceUpdateUserRequest Message for updating a UserUpdateUserRequest.Builder Message for updating a UserUser Message describing User object.User.Builder Message describing User object.UserName UserName.Builder Builder for projects/{project}/locations/{location}/clusters/{cluster}/users/{user}.UserPassword The username/password for a database user.UserPassword.Builder The username/password for a database user. -
Enum Summary Enum Description AutomatedBackupPolicy.RetentionCase AutomatedBackupPolicy.ScheduleCase Backup.State Backup StateBackup.Type Backup TypeBatchCreateInstanceStatus.State State contains all valid instance states for the BatchCreateInstances operation.Cluster.ClusterType Type of ClusterCluster.SourceCase Cluster.State Cluster StateClusterView View on Cluster.DatabaseVersion The supported database engine versions.EncryptionInfo.Type Possible encryption types.InjectFaultRequest.FaultType FaultType contains all valid types of faults that can be injected to an instance.Instance.AvailabilityType The Availability type of an instance.Instance.InstanceType Type of an InstanceInstance.State Instance StateInstanceView View on Instance.MigrationSource.MigrationSourceType Denote the type of migration source that created this cluster.OperationMetadata.RequestSpecificCase RestoreClusterRequest.SourceCase SslConfig.CaSource Certificate Authority (CA) source for SSL/TLS certificates.SslConfig.SslMode SSL mode options.SupportedDatabaseFlag.RestrictionsCase SupportedDatabaseFlag.ValueType ValueType describes the semantic type of the value that the flag accepts.User.UserType Enum that details the user type.