Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/alloydb:v1.ts";

§Classes

AlloyDB

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.

GoogleAuth

§Variables

auth

§Interfaces

AuthorizedNetwork

AuthorizedNetwork contains metadata for an authorized network.

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.

Backup

Message describing Backup object

BackupSource

Message describing a BackupSource.

CancelOperationRequest

The request message for Operations.CancelOperation.

ClientConnectionConfig

Client connection configuration

CloudControl2SharedOperationsReconciliationOperationMetadata

Operation metadata returned by the CLH during resource state reconciliation.

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.

ConnectionInfo

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

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.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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.

FailoverInstanceRequest

Message for triggering failover on an Instance

GoogleCloudLocationListLocationsResponse

The response message for Locations.ListLocations.

GoogleCloudLocationLocation

A resource that represents a Google Cloud location.

GoogleTypeTimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

InjectFaultRequest

Message for triggering fault injection on an instance

Instance

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

InstanceNetworkConfig

Metadata related to instance level network configuration.

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

MachineConfig

MachineConfig describes the configuration of a machine.

MaintenanceSchedule

MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead.

MaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates.

MaintenanceWindow

MaintenanceWindow specifies a preferred day and time for maintenance.

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. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationMetadata

Represents the metadata of the long-running operation.

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.

ProjectsLocationsBackupsCreateOptions

Additional options for AlloyDB#projectsLocationsBackupsCreate.

ProjectsLocationsBackupsDeleteOptions

Additional options for AlloyDB#projectsLocationsBackupsDelete.

ProjectsLocationsBackupsListOptions

Additional options for AlloyDB#projectsLocationsBackupsList.

ProjectsLocationsBackupsPatchOptions

Additional options for AlloyDB#projectsLocationsBackupsPatch.

ProjectsLocationsClustersCreateOptions

Additional options for AlloyDB#projectsLocationsClustersCreate.

ProjectsLocationsClustersCreatesecondaryOptions

Additional options for AlloyDB#projectsLocationsClustersCreatesecondary.

ProjectsLocationsClustersDeleteOptions

Additional options for AlloyDB#projectsLocationsClustersDelete.

ProjectsLocationsClustersGetOptions

Additional options for AlloyDB#projectsLocationsClustersGet.

ProjectsLocationsClustersInstancesCreateOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesCreate.

ProjectsLocationsClustersInstancesCreatesecondaryOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesCreatesecondary.

ProjectsLocationsClustersInstancesDeleteOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesDelete.

ProjectsLocationsClustersInstancesGetConnectionInfoOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesGetConnectionInfo.

ProjectsLocationsClustersInstancesGetOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesGet.

ProjectsLocationsClustersInstancesListOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesList.

ProjectsLocationsClustersInstancesPatchOptions

Additional options for AlloyDB#projectsLocationsClustersInstancesPatch.

ProjectsLocationsClustersListOptions

Additional options for AlloyDB#projectsLocationsClustersList.

ProjectsLocationsClustersPatchOptions

Additional options for AlloyDB#projectsLocationsClustersPatch.

ProjectsLocationsClustersUsersCreateOptions

Additional options for AlloyDB#projectsLocationsClustersUsersCreate.

ProjectsLocationsClustersUsersDeleteOptions

Additional options for AlloyDB#projectsLocationsClustersUsersDelete.

ProjectsLocationsClustersUsersListOptions

Additional options for AlloyDB#projectsLocationsClustersUsersList.

ProjectsLocationsClustersUsersPatchOptions

Additional options for AlloyDB#projectsLocationsClustersUsersPatch.

ProjectsLocationsListOptions

Additional options for AlloyDB#projectsLocationsList.

ProjectsLocationsOperationsListOptions

Additional options for AlloyDB#projectsLocationsOperationsList.

ProjectsLocationsSupportedDatabaseFlagsListOptions

Additional options for AlloyDB#projectsLocationsSupportedDatabaseFlagsList.

PromoteClusterRequest

Message for promoting a Cluster

PscConfig

PscConfig contains PSC related configuration at a cluster level.

PscInstanceConfig

PscInstanceConfig contains PSC related configuration at an instance level.

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)

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. This should be set if and only if the cluster is of type SECONDARY.

SslConfig

SSL configuration.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration

Configuration for availability of database instance

StorageDatabasecenterPartnerapiV1mainBackupConfiguration

Configuration for automatic backups

StorageDatabasecenterPartnerapiV1mainBackupRun

A backup run.

StorageDatabasecenterPartnerapiV1mainCompliance

Contains compliance information about a security standard indicating unmet recommendations.

StorageDatabasecenterPartnerapiV1mainCustomMetadataData

Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data

StorageDatabasecenterPartnerapiV1mainDatabaseMetadata

Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.

StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed

DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.

StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData

Common model for database resource health signal data.

StorageDatabasecenterPartnerapiV1mainDatabaseResourceId

DatabaseResourceId will serve as primary key for any resource ingestion event.

StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata

Common model for database resource instance metadata.

StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData

Common model for database resource recommendation signal data.

StorageDatabasecenterPartnerapiV1mainEntitlement

Proto representing the access that a user has to a specific feature/service. NextId: 3.

StorageDatabasecenterPartnerapiV1mainOperationError

An error that occurred during a backup creation operation.

StorageDatabasecenterPartnerapiV1mainRetentionSettings
StorageDatabasecenterPartnerapiV1mainUserLabels

Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.

StorageDatabasecenterProtoCommonProduct

Product specification for Condor resources.

StringRestrictions

Restrictions on STRING type values

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.

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. Used for specifying initial users at cluster creation time.

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.