Package com.google.cloud.alloydb.v1 (0.36.0)
| GitHub Repository | REST Documentation |
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.cloud.alloydb.v1.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: |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.cloud.alloydb.v1.AlloyDBAdminSettings |
Settings class to configure an instance of AlloyDBAdminClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListBackupsFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListBackupsPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListBackupsPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListClustersFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListClustersPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListClustersPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListInstancesFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListInstancesPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListInstancesPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListLocationsFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListLocationsPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListLocationsPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListSupportedDatabaseFlagsFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListSupportedDatabaseFlagsPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListSupportedDatabaseFlagsPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListUsersFixedSizeCollection | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListUsersPage | |
| com.google.cloud.alloydb.v1.AlloyDBAdminClient.ListUsersPagedResponse | |
| com.google.cloud.alloydb.v1.AlloyDBAdminGrpc | Service describing handlers for resources |
| com.google.cloud.alloydb.v1.AlloyDBAdminGrpc.AlloyDBAdminImplBase | Base class for the server implementation of the service AlloyDBAdmin. Service describing handlers for resources |
| com.google.cloud.alloydb.v1.AlloyDBAdminSettings.Builder | Builder for AlloyDBAdminSettings. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy | Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.Builder | Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention | A quantity based policy specifies that a certain number of the most recent successful backups should be retained. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention.Builder | A quantity based policy specifies that a certain number of the most recent successful backups should be retained. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention | A time based retention policy specifies that all backups within a certain time period should be retained. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention.Builder | A time based retention policy specifies that all backups within a certain time period should be retained. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule | A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. |
| com.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule.Builder | A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. |
| com.google.cloud.alloydb.v1.Backup | Message describing Backup object |
| com.google.cloud.alloydb.v1.Backup.Builder | Message describing Backup object |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.BackupName | |
| com.google.cloud.alloydb.v1.BackupName.Builder | Builder for projects/{project}/locations/{location}/backups/{backup}. |
| com.google.cloud.alloydb.v1.BackupSource | Message describing a BackupSource. |
| com.google.cloud.alloydb.v1.BackupSource.Builder | Message describing a BackupSource. |
| com.google.cloud.alloydb.v1.BatchCreateInstanceStatus | Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, |
| com.google.cloud.alloydb.v1.BatchCreateInstanceStatus.Builder | Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, |
| com.google.cloud.alloydb.v1.BatchCreateInstancesMetadata | Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3 |
| com.google.cloud.alloydb.v1.BatchCreateInstancesMetadata.Builder | Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3 |
| com.google.cloud.alloydb.v1.BatchCreateInstancesRequest | Message for creating a batch of instances under the specified cluster. |
| com.google.cloud.alloydb.v1.BatchCreateInstancesRequest.Builder | Message for creating a batch of instances under the specified cluster. |
| com.google.cloud.alloydb.v1.BatchCreateInstancesResponse | Message for creating batches of instances in a cluster. |
| com.google.cloud.alloydb.v1.BatchCreateInstancesResponse.Builder | Message for creating batches of instances in a cluster. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.Cluster.NetworkConfig | Metadata related to network configuration. |
| com.google.cloud.alloydb.v1.Cluster.NetworkConfig.Builder | Metadata related to network configuration. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.Cluster.SecondaryConfig | Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. |
| com.google.cloud.alloydb.v1.Cluster.SecondaryConfig.Builder | Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. |
| com.google.cloud.alloydb.v1.ClusterName | |
| com.google.cloud.alloydb.v1.ClusterName.Builder | Builder for projects/{project}/locations/{location}/clusters/{cluster}. |
| com.google.cloud.alloydb.v1.ConnectionInfo | ConnectionInfo singleton resource. https://google.aip.dev/156 |
| com.google.cloud.alloydb.v1.ConnectionInfo.Builder | ConnectionInfo singleton resource. https://google.aip.dev/156 |
| com.google.cloud.alloydb.v1.ContinuousBackupConfig | ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. |
| com.google.cloud.alloydb.v1.ContinuousBackupConfig.Builder | ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. |
| com.google.cloud.alloydb.v1.ContinuousBackupInfo | ContinuousBackupInfo describes the continuous backup properties of a cluster. |
| com.google.cloud.alloydb.v1.ContinuousBackupInfo.Builder | ContinuousBackupInfo describes the continuous backup properties of a cluster. |
| com.google.cloud.alloydb.v1.ContinuousBackupSource | Message describing a ContinuousBackupSource. |
| com.google.cloud.alloydb.v1.ContinuousBackupSource.Builder | Message describing a ContinuousBackupSource. |
| com.google.cloud.alloydb.v1.CreateBackupRequest | Message for creating a Backup |
| com.google.cloud.alloydb.v1.CreateBackupRequest.Builder | Message for creating a Backup |
| com.google.cloud.alloydb.v1.CreateClusterRequest | Message for creating a Cluster |
| com.google.cloud.alloydb.v1.CreateClusterRequest.Builder | Message for creating a Cluster |
| com.google.cloud.alloydb.v1.CreateInstanceRequest | Message for creating a Instance |
| com.google.cloud.alloydb.v1.CreateInstanceRequest.Builder | Message for creating a Instance |
| com.google.cloud.alloydb.v1.CreateInstanceRequests | See usage below for notes. |
| com.google.cloud.alloydb.v1.CreateInstanceRequests.Builder | See usage below for notes. |
| com.google.cloud.alloydb.v1.CreateSecondaryClusterRequest |
Protobuf type google.cloud.alloydb.v1.CreateSecondaryClusterRequest |
| com.google.cloud.alloydb.v1.CreateSecondaryClusterRequest.Builder |
Protobuf type google.cloud.alloydb.v1.CreateSecondaryClusterRequest |
| com.google.cloud.alloydb.v1.CreateSecondaryInstanceRequest | Message for creating a Secondary Instance |
| com.google.cloud.alloydb.v1.CreateSecondaryInstanceRequest.Builder | Message for creating a Secondary Instance |
| com.google.cloud.alloydb.v1.CreateUserRequest | Message for creating a User |
| com.google.cloud.alloydb.v1.CreateUserRequest.Builder | Message for creating a User |
| com.google.cloud.alloydb.v1.DeleteBackupRequest | Message for deleting a Backup |
| com.google.cloud.alloydb.v1.DeleteBackupRequest.Builder | Message for deleting a Backup |
| com.google.cloud.alloydb.v1.DeleteClusterRequest | Message for deleting a Cluster |
| com.google.cloud.alloydb.v1.DeleteClusterRequest.Builder | Message for deleting a Cluster |
| com.google.cloud.alloydb.v1.DeleteInstanceRequest | Message for deleting a Instance |
| com.google.cloud.alloydb.v1.DeleteInstanceRequest.Builder | Message for deleting a Instance |
| com.google.cloud.alloydb.v1.DeleteUserRequest | Message for deleting a User |
| com.google.cloud.alloydb.v1.DeleteUserRequest.Builder | Message for deleting a User |
| com.google.cloud.alloydb.v1.EncryptionConfig | EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). |
| com.google.cloud.alloydb.v1.EncryptionConfig.Builder | EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). |
| com.google.cloud.alloydb.v1.EncryptionInfo | EncryptionInfo describes the encryption information of a cluster or a backup. |
| com.google.cloud.alloydb.v1.EncryptionInfo.Builder | EncryptionInfo describes the encryption information of a cluster or a backup. |
| com.google.cloud.alloydb.v1.FailoverInstanceRequest | Message for triggering failover on an Instance |
| com.google.cloud.alloydb.v1.FailoverInstanceRequest.Builder | Message for triggering failover on an Instance |
| com.google.cloud.alloydb.v1.GenerateClientCertificateRequest | Message for requests to generate a client certificate signed by the Cluster CA. |
| com.google.cloud.alloydb.v1.GenerateClientCertificateRequest.Builder | Message for requests to generate a client certificate signed by the Cluster CA. |
| com.google.cloud.alloydb.v1.GenerateClientCertificateResponse | Message returned by a GenerateClientCertificate operation. |
| com.google.cloud.alloydb.v1.GenerateClientCertificateResponse.Builder | Message returned by a GenerateClientCertificate operation. |
| com.google.cloud.alloydb.v1.GetBackupRequest | Message for getting a Backup |
| com.google.cloud.alloydb.v1.GetBackupRequest.Builder | Message for getting a Backup |
| com.google.cloud.alloydb.v1.GetClusterRequest | Message for getting a Cluster |
| com.google.cloud.alloydb.v1.GetClusterRequest.Builder | Message for getting a Cluster |
| com.google.cloud.alloydb.v1.GetConnectionInfoRequest | Request message for GetConnectionInfo. |
| com.google.cloud.alloydb.v1.GetConnectionInfoRequest.Builder | Request message for GetConnectionInfo. |
| com.google.cloud.alloydb.v1.GetInstanceRequest | Message for getting a Instance |
| com.google.cloud.alloydb.v1.GetInstanceRequest.Builder | Message for getting a Instance |
| com.google.cloud.alloydb.v1.GetUserRequest | Message for getting a User |
| com.google.cloud.alloydb.v1.GetUserRequest.Builder | Message for getting a User |
| com.google.cloud.alloydb.v1.InjectFaultRequest | Message for triggering fault injection on an instance |
| com.google.cloud.alloydb.v1.InjectFaultRequest.Builder | Message for triggering fault injection on an instance |
| com.google.cloud.alloydb.v1.Instance | An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.Instance.ClientConnectionConfig | Client connection configuration |
| com.google.cloud.alloydb.v1.Instance.ClientConnectionConfig.Builder | Client connection configuration |
| com.google.cloud.alloydb.v1.Instance.MachineConfig | MachineConfig describes the configuration of a machine. |
| com.google.cloud.alloydb.v1.Instance.MachineConfig.Builder | MachineConfig describes the configuration of a machine. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig | QueryInsights Instance specific configuration. |
| com.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig.Builder | QueryInsights Instance specific configuration. |
| com.google.cloud.alloydb.v1.Instance.ReadPoolConfig | Configuration for a read pool instance. |
| com.google.cloud.alloydb.v1.Instance.ReadPoolConfig.Builder | Configuration for a read pool instance. |
| com.google.cloud.alloydb.v1.InstanceName | |
| com.google.cloud.alloydb.v1.InstanceName.Builder | Builder for projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}. |
| com.google.cloud.alloydb.v1.ListBackupsRequest | Message for requesting list of Backups |
| com.google.cloud.alloydb.v1.ListBackupsRequest.Builder | Message for requesting list of Backups |
| com.google.cloud.alloydb.v1.ListBackupsResponse | Message for response to listing Backups |
| com.google.cloud.alloydb.v1.ListBackupsResponse.Builder | Message for response to listing Backups |
| com.google.cloud.alloydb.v1.ListClustersRequest | Message for requesting list of Clusters |
| com.google.cloud.alloydb.v1.ListClustersRequest.Builder | Message for requesting list of Clusters |
| com.google.cloud.alloydb.v1.ListClustersResponse | Message for response to listing Clusters |
| com.google.cloud.alloydb.v1.ListClustersResponse.Builder | Message for response to listing Clusters |
| com.google.cloud.alloydb.v1.ListInstancesRequest | Message for requesting list of Instances |
| com.google.cloud.alloydb.v1.ListInstancesRequest.Builder | Message for requesting list of Instances |
| com.google.cloud.alloydb.v1.ListInstancesResponse | Message for response to listing Instances |
| com.google.cloud.alloydb.v1.ListInstancesResponse.Builder | Message for response to listing Instances |
| com.google.cloud.alloydb.v1.ListSupportedDatabaseFlagsRequest | Message for listing the information about the supported Database flags. |
| com.google.cloud.alloydb.v1.ListSupportedDatabaseFlagsRequest.Builder | Message for listing the information about the supported Database flags. |
| com.google.cloud.alloydb.v1.ListSupportedDatabaseFlagsResponse | Message for response to listing SupportedDatabaseFlags. |
| com.google.cloud.alloydb.v1.ListSupportedDatabaseFlagsResponse.Builder | Message for response to listing SupportedDatabaseFlags. |
| com.google.cloud.alloydb.v1.ListUsersRequest | Message for requesting list of Users |
| com.google.cloud.alloydb.v1.ListUsersRequest.Builder | Message for requesting list of Users |
| com.google.cloud.alloydb.v1.ListUsersResponse | Message for response to listing Users |
| com.google.cloud.alloydb.v1.ListUsersResponse.Builder | Message for response to listing Users |
| com.google.cloud.alloydb.v1.LocationName | |
| com.google.cloud.alloydb.v1.LocationName.Builder | Builder for projects/{project}/locations/{location}. |
| com.google.cloud.alloydb.v1.MigrationSource | Subset of the source instance configuration that is available when reading the cluster resource. |
| com.google.cloud.alloydb.v1.MigrationSource.Builder | Subset of the source instance configuration that is available when reading the cluster resource. |
| com.google.cloud.alloydb.v1.OperationMetadata | Represents the metadata of the long-running operation. |
| com.google.cloud.alloydb.v1.OperationMetadata.Builder | Represents the metadata of the long-running operation. |
| com.google.cloud.alloydb.v1.PromoteClusterRequest | Message for promoting a Cluster |
| com.google.cloud.alloydb.v1.PromoteClusterRequest.Builder | Message for promoting a Cluster |
| com.google.cloud.alloydb.v1.ResourcesProto | |
| com.google.cloud.alloydb.v1.RestartInstanceRequest |
Protobuf type google.cloud.alloydb.v1.RestartInstanceRequest |
| com.google.cloud.alloydb.v1.RestartInstanceRequest.Builder |
Protobuf type google.cloud.alloydb.v1.RestartInstanceRequest |
| com.google.cloud.alloydb.v1.RestoreClusterRequest | Message for restoring a Cluster from a backup or another cluster at a given point in time. |
| com.google.cloud.alloydb.v1.RestoreClusterRequest.Builder | Message for restoring a Cluster from a backup or another cluster at a given point in time. |
| com.google.cloud.alloydb.v1.ServiceProto | |
| com.google.cloud.alloydb.v1.SslConfig | SSL configuration. |
| com.google.cloud.alloydb.v1.SslConfig.Builder | SSL configuration. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.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. |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlag.IntegerRestrictions | Restrictions on INTEGER type values. |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlag.IntegerRestrictions.Builder | Restrictions on INTEGER type values. |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlag.StringRestrictions | Restrictions on STRING type values |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlag.StringRestrictions.Builder | Restrictions on STRING type values |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlagName | |
| com.google.cloud.alloydb.v1.SupportedDatabaseFlagName.Builder | Builder for projects/{project}/locations/{location}/flags/{flag}. |
| com.google.cloud.alloydb.v1.UpdateBackupRequest | Message for updating a Backup |
| com.google.cloud.alloydb.v1.UpdateBackupRequest.Builder | Message for updating a Backup |
| com.google.cloud.alloydb.v1.UpdateClusterRequest | Message for updating a Cluster |
| com.google.cloud.alloydb.v1.UpdateClusterRequest.Builder | Message for updating a Cluster |
| com.google.cloud.alloydb.v1.UpdateInstanceRequest | Message for updating a Instance |
| com.google.cloud.alloydb.v1.UpdateInstanceRequest.Builder | Message for updating a Instance |
| com.google.cloud.alloydb.v1.UpdateUserRequest | Message for updating a User |
| com.google.cloud.alloydb.v1.UpdateUserRequest.Builder | Message for updating a User |
| com.google.cloud.alloydb.v1.User | Message describing User object. |
| com.google.cloud.alloydb.v1.User.Builder | Message describing User object. |
| com.google.cloud.alloydb.v1.UserName | |
| com.google.cloud.alloydb.v1.UserName.Builder | Builder for projects/{project}/locations/{location}/clusters/{cluster}/users/{user}. |
| com.google.cloud.alloydb.v1.UserPassword | The username/password for a database user. Used for specifying initial users at cluster creation time. |
| com.google.cloud.alloydb.v1.UserPassword.Builder | The username/password for a database user. Used for specifying initial users at cluster creation time. |