Show / Hide Table of Contents

Namespace Google.Apis.CloudAlloyDBAdmin.v1.Data

Classes

AlloydbClhErrorsAlloyDbInternalDebugInfo

AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.

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

BackupDrBackupSource

Message describing a BackupDrBackupSource.

BackupDrEnabledWindow

Information about a single window when BackupDR was enabled for this cluster.

BackupDrInfo

Information about BackupDR protection for this cluster.

BackupDrPitrSource

Message describing a BackupDrPitrSource.

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.

CloudSQLBackupRunSource

The source CloudSQL backup resource.

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.

ClusterUpgradeDetails

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

ConnectionInfo

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

ConnectionPoolConfig

Configuration for Managed Connection Pool (MCP).

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.

CsvExportOptions

Options for exporting data in CSV format.

CsvImportOptions

Options for importing data in CSV format.

DataplexConfig

Configuration for Dataplex integration.

DenyMaintenancePeriod

DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.

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.

ExportClusterRequest

Export cluster request.

ExportClusterResponse

Response of export cluster rpc.

FailoverInstanceRequest

Message for triggering failover on an Instance

GcsDestination

Destination for Export. Export will be done to cloud storage.

GoogleCloudLocationListLocationsResponse

The response message for Locations.ListLocations.

GoogleCloudLocationLocation

A resource that represents a Google Cloud location.

GoogleTypeDate

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

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.

ImportClusterRequest

Import cluster request.

ImportClusterResponse

Response of import rpc.

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.

InstanceUpgradeDetails

Details regarding the upgrade of instances associated with a cluster.

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 ephemeral, they can change during update, failover, autohealing and resize operations.

ObservabilityInstanceConfig

Observability Instance specific configuration.

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.

PromoteClusterRequest

Message for promoting a Cluster

PscAutoConnectionConfig

Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.

PscConfig

PscConfig contains PSC related configuration at a cluster level.

PscInstanceConfig

PscInstanceConfig contains PSC related configuration at an instance level.

PscInterfaceConfig

Configuration for setting up a PSC interface to enable outbound connectivity.

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.

ReadPoolInstancesUpgradeStageStatus

Read pool instances upgrade specific status.

RestartInstanceRequest

RestoreClusterRequest

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

RestoreFromCloudSQLRequest

Message for registering Restoring from CloudSQL resource.

SecondaryConfig

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

SqlExportOptions

Options for exporting data in SQL format.

SqlImportOptions

Options for importing data in SQL format.

SslConfig

SSL configuration.

StageInfo

Stage information for different stages in the upgrade process.

StageStatus

Status of an upgrade stage.

Stats

Upgrade stats for read pool instances.

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

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainBackupConfiguration

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainBackupDRMetadata

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainBackupRun

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainCompliance

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainCustomMetadataData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceId

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainEntitlement

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainIpAddress

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainMachineConfiguration

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainObservabilityMetricData

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainOperationError

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainResourceFlags

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainRetentionSettings

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainSignalMetadata

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainTags

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance

Disable validation warnings

StorageDatabasecenterPartnerapiV1mainUserLabels

Disable validation warnings

StorageDatabasecenterProtoCommonProduct

Product specification for Condor resources.

StorageDatabasecenterProtoCommonTypedValue

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

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.

SwitchoverClusterRequest

Message for switching over to a cluster

TimeBasedRetention

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

TrialMetadata

Contains information and all metadata related to TRIAL clusters.

UpgradeClusterRequest

Upgrades a cluster.

UpgradeClusterResponse

UpgradeClusterResponse contains the response for upgrade cluster operation.

UpgradeClusterStatus

Message for current status of the Major Version Upgrade operation.

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.

In this article
Back to top Generated by DocFX