alloydb/v1 library
AlloyDB API - v1
AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
For more information, see cloud.google.com/alloydb/
Create an instance of CloudAlloyDBAdminApi to access these resources:
Classes
- AutomatedBackupPolicy
- Message describing the user-specified automated backup policy.
- Backup
- Message describing Backup object
- BackupSource
- Message describing a BackupSource.
- ClientConnectionConfig
- Client connection configuration
- CloudAlloyDBAdminApi
- AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications.
- Cluster
- A cluster is a collection of regional AlloyDB resources.
- ConnectionInfo
- ConnectionInfo singleton 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.
- EncryptionInfo
- EncryptionInfo describes the encryption information of a cluster or a backup.
- 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.
- GoogleCloudLocationListLocationsResponse
- The response message for Locations.ListLocations.
- InjectFaultRequest
- Message for triggering fault injection on an instance
- Instance
- An Instance is a computing unit that an end customer can connect to.
- IntegerRestrictions
- Restrictions on INTEGER type values.
- ListBackupsResponse
- Message for response to listing Backups
- ListClustersResponse
- Message for response to listing Clusters
- ListInstancesResponse
- Message for response to listing Instances
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListSupportedDatabaseFlagsResponse
- Message for response to listing SupportedDatabaseFlags.
- ListUsersResponse
- Message for response to listing Users
- MigrationSource
- Subset of the source instance configuration that is available when reading the cluster resource.
- NetworkConfig
- Metadata related to network configuration.
- Node
- Details of a single node in the instance.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- PrimaryConfig
- Configuration for the primary cluster.
- ProjectsLocationsBackupsResource
- ProjectsLocationsClustersInstancesResource
- ProjectsLocationsClustersResource
- ProjectsLocationsClustersUsersResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsResource
- ProjectsLocationsSupportedDatabaseFlagsResource
- ProjectsResource
- PromoteClusterRequest
- Message for promoting a Cluster
- 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.
- QuantityBasedRetention
- A quantity based policy specifies that a certain number of the most recent successful backups should be retained.
- QueryInsightsInstanceConfig
- QueryInsights Instance specific configuration.
- ReadPoolConfig
- Configuration for a read pool instance.
- RestartInstanceRequest
- RestoreClusterRequest
- Message for restoring a Cluster from a backup or another cluster at a given point in time.
- SecondaryConfig
- Configuration information for the secondary cluster.
- SslConfig
- SSL configuration.
- StringRestrictions
- Restrictions on STRING type values
- SupportedDatabaseFlag
- SupportedDatabaseFlag gives general information about a database flag, like type and allowed values.
- TimeBasedRetention
- A time based retention policy specifies that all backups within a certain time period should be retained.
- User
- Message describing User object.
- UserPassword
- The username/password for a database user.
- WeeklySchedule
- A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.
Typedefs
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- EncryptionConfig = $EncryptionConfig
- EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).
- GoogleCloudLocationLocation = $Location00
- A resource that represents a Google Cloud location.
- GoogleTypeTimeOfDay = $TimeOfDay
- Represents a time of day.
- MachineConfig = $MachineConfig
- MachineConfig describes the configuration of a machine.
- Status = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.