View Source API Reference google_api_alloy_db v0.11.0

Modules

API client metadata for GoogleApi.AlloyDB.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.AlloyDB.V1.

AuthorizedNetwork contains metadata for an authorized network.

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.

Message describing Backup object

Message describing a BackupSource.

The request message for Operations.CancelOperation.

Client connection configuration

Operation metadata returned by the CLH during resource state reconciliation.

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.

Upgrade details of a cluster. This cluster can be primary or secondary.

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

ContinuousBackupInfo describes the continuous backup properties of a cluster.

Message describing a ContinuousBackupSource.

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 describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).

EncryptionInfo describes the encryption information of a cluster or a backup.

Message for triggering failover on an Instance

The response message for Locations.ListLocations.

A resource that represents a Google Cloud location.

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.

Message for triggering fault injection on an instance

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

Metadata related to instance-level network configuration.

Details regarding the upgrade of instaces associated with a cluster.

Restrictions on INTEGER type values.

Message for response to listing Backups

Message for response to listing Clusters

Message for response to listing Instances

The response message for Operations.ListOperations.

Message for response to listing SupportedDatabaseFlags.

Message for response to listing Users

MachineConfig describes the configuration of a machine.

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 defines the policy for system updates.

MaintenanceWindow specifies a preferred day and time for maintenance.

Subset of the source instance configuration that is available when reading the cluster resource.

Metadata related to network configuration.

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.

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

Represents the metadata of the long-running operation.

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.

Message for promoting a Cluster

PscConfig contains PSC related configuration at a cluster level.

PscInstanceConfig contains PSC related configuration at an instance level.

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)

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

QueryInsights Instance specific configuration.

Configuration for a read pool instance.

Attributes

  • nodeIds (type: list(String.t), default: nil) - Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
  • requestId (type: String.t, default: nil) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • validateOnly (type: boolean(), default: nil) - Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

Message for restoring a Cluster from a backup or another cluster at a given point in time.

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

Stage information for different stages in the upgrade process.

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.

Contains compliance information about a security standard indicating unmet recommendations.

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

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

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

Common model for database resource instance metadata. Next ID: 22

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

Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.

MachineConfiguration describes the configuration of a machine specific to Database Resource.

Attributes

  • aggregationType (type: String.t, default: nil) - Required. Type of aggregation performed on the metric.
  • metricType (type: String.t, default: nil) - Required. Type of metric like CPU, Memory, etc.
  • observationTime (type: DateTime.t, default: nil) - Required. The time the metric value was observed.
  • resourceName (type: String.t, default: nil) - Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
  • value (type: GoogleApi.AlloyDB.V1.Model.StorageDatabasecenterProtoCommonTypedValue.t, default: nil) - Required. Value of the metric type.

An error that occurred during a backup creation operation.

Attributes

  • durationBasedRetention (type: String.t, default: nil) - Duration based retention period i.e. 172800 seconds (2 days)
  • quantityBasedRetention (type: integer(), default: nil) -
  • retentionUnit (type: String.t, default: nil) - The unit that 'retained_backups' represents.
  • timeBasedRetention (type: String.t, default: nil) -

Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.

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.

Product specification for Condor resources.

TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.

Restrictions on STRING type values

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.

Message for switching over to a cluster

A time based retention policy specifies that all backups within a certain time period should be retained.

Contains information and all metadata related to TRIAL clusters.

UpgradeClusterResponse contains the response for upgrade cluster operation.

Message describing User object.

The username/password for a database user. Used for specifying initial users at cluster creation time.

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.