Returns the instances Resource.
Returns the users Resource.
Close httplib2 connections.
create(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Cluster in a given project and location.
createsecondary(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
delete(name, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Cluster.
get(name, view=None, x__xgafv=None)
Gets details of a single Cluster.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Clusters in a given project and location.
Retrieves the next page of results.
Updates the parameters of a single Cluster.
promote(name, body=None, x__xgafv=None)
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
restore(parent, body=None, x__xgafv=None)
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
switchover(name, body=None, x__xgafv=None)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
upgrade(name, body=None, x__xgafv=None)
Upgrades a single Cluster. Imperative only.
close()
Close httplib2 connections.
create(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Cluster in a given project and location.
Args:
parent: string, Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
clusterId: string, Required. ID of the requesting object.
requestId: string, 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: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
createsecondary(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Args:
parent: string, Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
clusterId: string, Required. ID of the requesting object (the secondary cluster).
requestId: string, 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: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Cluster.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field. (required)
etag: string, Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, Optional. Whether to cascade delete child instances for given cluster.
requestId: string, 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: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets details of a single Cluster.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field. (required)
view: string, Optional. The view of the cluster to return. Returns all default fields if not set.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
CLUSTER_VIEW_BASIC - BASIC server responses include all the relevant cluster details, excluding Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific fields. The default value.
CLUSTER_VIEW_CONTINUOUS_BACKUP - CONTINUOUS_BACKUP response returns all the fields from BASIC plus the earliest restorable time if continuous backups are enabled. May increase latency.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Clusters in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/- (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Clusters
"clusters": [ # The list of 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.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single Cluster.
Args:
name: string, Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
allowMissing: boolean, Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and `update_mask` is ignored.
requestId: string, 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).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
promote(name, body=None, x__xgafv=None)
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field (required)
body: object, The request body.
The object takes the form of:
{ # Message for promoting a Cluster
"etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
"requestId": "A String", # 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 original operation with the same request ID was received, and if so, will ignore 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": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
restore(parent, body=None, x__xgafv=None)
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for restoring a Cluster from a backup or another cluster at a given point in time.
"backupSource": { # Message describing a BackupSource. # Backup source.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"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. # Required. The resource being created
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"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. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"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. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # 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`.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot.
"backupRunId": "A String", # Required. The CloudSQL backup run ID.
"instanceId": "A String", # Required. The CloudSQL instance ID.
"project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"geminiConfig": { # Cluster level configuration parameters related to the Gemini in Databases add-on. # Optional. Configuration parameters related to the Gemini in Databases add-on.
"entitled": True or False, # Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"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. # Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
"startTime": "A String", # Output only. The scheduled start time for the maintenance.
},
"maintenanceUpdatePolicy": { # MaintenanceUpdatePolicy defines the policy for system updates. # Optional. The maintenance update policy determines when to allow or deny updates.
"maintenanceWindows": [ # Preferred windows to perform maintenance. Currently limited to 1.
{ # MaintenanceWindow specifies a preferred day and time for maintenance.
"day": "A String", # Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"startTime": { # 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`. # Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a 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. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"pscConfig": { # PscConfig contains PSC related configuration at a cluster level. # Optional. The configuration for Private Service Connect (PSC) for the cluster.
"pscEnabled": True or False, # Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
"serviceOwnedProjectNumber": "A String", # Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"subscriptionType": "A String", # Optional. Subscription type of the cluster.
"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
"a_key": "A String",
},
"trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters
"endTime": "A String", # End time of the trial cluster.
"graceEndTime": "A String", # grace end time of the cluster.
"startTime": "A String", # start time of the trial cluster.
"upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster.
},
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
},
"clusterId": "A String", # Required. ID of the requesting object.
"continuousBackupSource": { # Message describing a ContinuousBackupSource. # ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.
"cluster": "A String", # Required. The source cluster from which to restore. This cluster must have continuous backup enabled for this operation to succeed. For the required format, see the comment on the Cluster.name field.
"pointInTime": "A String", # Required. The point in time to restore to.
},
"requestId": "A String", # 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": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
switchover(name, body=None, x__xgafv=None)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field (required)
body: object, The request body.
The object takes the form of:
{ # Message for switching over to a cluster
"requestId": "A String", # 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": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
upgrade(name, body=None, x__xgafv=None)
Upgrades a single Cluster. Imperative only.
Args:
name: string, Required. The resource name of the cluster. (required)
body: object, The request body.
The object takes the form of:
{ # Upgrades a cluster.
"etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
"requestId": "A String", # 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": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
"version": "A String", # Required. The version the cluster is going to be upgraded to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}