package service
- Alphabetic
- Public
- Protected
Type Members
- trait AlloyDBAdmin[F[_]] extends AnyRef
Service describing handlers for resources
- final case class BatchCreateInstanceStatus(state: State = com.google.cloud.alloydb.v1.service.BatchCreateInstanceStatus.State.STATE_UNSPECIFIED, errorMsg: String = "", error: Option[Status] = _root_.scala.None, type: InstanceType = com.google.cloud.alloydb.v1.resources.Instance.InstanceType.INSTANCE_TYPE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchCreateInstanceStatus] with Product with Serializable
Message for current status of an instance in the BatchCreateInstances operation.
Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, Instance1 through Instance4. Lets also assume that 2 instances succeeded but the third failed to create and the 4th was never picked up for creation because of failure of the previous one. Then, resulting states would look something like:
- Instance1 = ROLLED_BACK 2. Instance2 = ROLLED_BACK 3. Instance3 = FAILED 4. Instance4 = FAILED
However, while the operation is running, the instance might be in other states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states / do not get further updated once the operation is done.
- state
The current state of an instance involved in the batch create operation. Once the operation is complete, the final state of the instances in the LRO can be one of:
- ACTIVE, indicating that instances were created successfully 2. FAILED, indicating that a particular instance failed creation 3. ROLLED_BACK indicating that although the instance was created successfully, it had to be rolled back and deleted due to failure in other steps of the workflow.
- errorMsg
DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.
- error
The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.
- Annotations
- @SerialVersionUID()
- final case class BatchCreateInstancesMetadata(instanceTargets: Seq[String] = _root_.scala.Seq.empty, instanceStatuses: Map[String, BatchCreateInstanceStatus] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchCreateInstancesMetadata] with Product with Serializable
Message for metadata that is specific to BatchCreateInstances API.
Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3
- instanceTargets
The instances being created in the API call. Each string in this list is the server defined resource path for target instances in the request and for the format of each string, see the comment on the Instance.name field.
- instanceStatuses
A map representing state of the instances involved in the BatchCreateInstances operation during the operation execution. The instance state will be in STATE_UNSPECIFIED state if the instance has not yet been picked up for processing. The key of the map is the name of the instance resource. For the format, see the comment on the Instance.name field.
- Annotations
- @SerialVersionUID()
- final case class BatchCreateInstancesRequest(parent: String = "", requests: Option[CreateInstanceRequests] = _root_.scala.None, requestId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchCreateInstancesRequest] with Product with Serializable
Message for creating a batch of instances under the specified cluster.
Message for creating a batch of instances under the specified cluster.
- parent
Required. The name of the parent resource.
- requests
Required. Resources being created.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).
- Annotations
- @SerialVersionUID()
- final case class BatchCreateInstancesResponse(instances: Seq[Instance] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchCreateInstancesResponse] with Product with Serializable
Message for creating batches of instances in a cluster.
Message for creating batches of instances in a cluster.
- instances
Created instances.
- Annotations
- @SerialVersionUID()
- final case class CreateBackupRequest(parent: String = "", backupId: String = "", backup: Option[Backup] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateBackupRequest] with Product with Serializable
Message for creating a Backup
Message for creating a Backup
- parent
Required. Value for parent.
- backupId
Required. ID of the requesting object.
- backup
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- Annotations
- @SerialVersionUID()
- final case class CreateClusterRequest(parent: String = "", clusterId: String = "", cluster: Option[Cluster] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateClusterRequest] with Product with Serializable
Message for creating a Cluster
Message for creating a Cluster
- parent
Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
- clusterId
Required. ID of the requesting object.
- cluster
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
- Annotations
- @SerialVersionUID()
- final case class CreateInstanceRequest(parent: String = "", instanceId: String = "", instance: Option[Instance] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateInstanceRequest] with Product with Serializable
Message for creating a Instance
Message for creating a Instance
- parent
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
- instanceId
Required. ID of the requesting object.
- instance
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
- Annotations
- @SerialVersionUID()
- final case class CreateInstanceRequests(createInstanceRequests: Seq[CreateInstanceRequest] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateInstanceRequests] with Product with Serializable
See usage below for notes.
See usage below for notes.
- createInstanceRequests
Required. Primary and read replica instances to be created. This list should not be empty.
- Annotations
- @SerialVersionUID()
- final case class CreateSecondaryClusterRequest(parent: String = "", clusterId: String = "", cluster: Option[Cluster] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateSecondaryClusterRequest] with Product with Serializable
- parent
Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
- clusterId
Required. ID of the requesting object (the secondary cluster).
- cluster
Required. Configuration of the requesting object (the secondary cluster).
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
- Annotations
- @SerialVersionUID()
- final case class CreateSecondaryInstanceRequest(parent: String = "", instanceId: String = "", instance: Option[Instance] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateSecondaryInstanceRequest] with Product with Serializable
Message for creating a Secondary Instance
Message for creating a Secondary Instance
- parent
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
- instanceId
Required. ID of the requesting object.
- instance
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
- Annotations
- @SerialVersionUID()
- final case class CreateUserRequest(parent: String = "", userId: String = "", user: Option[User] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateUserRequest] with Product with Serializable
Message for creating a User
Message for creating a User
- parent
Required. Value for parent.
- userId
Required. ID of the requesting object.
- user
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- Annotations
- @SerialVersionUID()
- final case class DeleteBackupRequest(name: String = "", requestId: String = "", validateOnly: Boolean = false, etag: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteBackupRequest] with Product with Serializable
Message for deleting a Backup
Message for deleting a Backup
- name
Required. Name of the resource. For the required format, see the comment on the Backup.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- etag
Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.
- Annotations
- @SerialVersionUID()
- final case class DeleteClusterRequest(name: String = "", requestId: String = "", etag: String = "", validateOnly: Boolean = false, force: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteClusterRequest] with Product with Serializable
Message for deleting a Cluster
Message for deleting a Cluster
- name
Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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).
- etag
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.
- validateOnly
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
- force
Optional. Whether to cascade delete child instances for given cluster.
- Annotations
- @SerialVersionUID()
- final case class DeleteInstanceRequest(name: String = "", requestId: String = "", etag: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteInstanceRequest] with Product with Serializable
Message for deleting a Instance
Message for deleting a Instance
- name
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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).
- etag
Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
- validateOnly
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
- Annotations
- @SerialVersionUID()
- final case class DeleteUserRequest(name: String = "", requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteUserRequest] with Product with Serializable
Message for deleting a User
Message for deleting a User
- name
Required. The name of the resource. For the required format, see the comment on the User.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- Annotations
- @SerialVersionUID()
- final case class FailoverInstanceRequest(name: String = "", requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FailoverInstanceRequest] with Product with Serializable
Message for triggering failover on an Instance
Message for triggering failover on an Instance
- name
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.
- Annotations
- @SerialVersionUID()
- final case class GenerateClientCertificateRequest(parent: String = "", requestId: String = "", certDuration: Option[Duration] = _root_.scala.None, publicKey: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GenerateClientCertificateRequest] with Product with Serializable
Message for requests to generate a client certificate signed by the Cluster CA.
Message for requests to generate a client certificate signed by the Cluster CA.
- parent
Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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).
- certDuration
Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
- publicKey
Optional. The public key from the client.
- Annotations
- @SerialVersionUID()
- final case class GenerateClientCertificateResponse(pemCertificateChain: Seq[String] = _root_.scala.Seq.empty, caCert: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GenerateClientCertificateResponse] with Product with Serializable
Message returned by a GenerateClientCertificate operation.
Message returned by a GenerateClientCertificate operation.
- pemCertificateChain
Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
- caCert
Optional. The pem-encoded cluster ca X.509 certificate.
- Annotations
- @SerialVersionUID()
- final case class GetBackupRequest(name: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetBackupRequest] with Product with Serializable
Message for getting a Backup
Message for getting a Backup
- name
Required. Name of the resource
- Annotations
- @SerialVersionUID()
- final case class GetClusterRequest(name: String = "", view: ClusterView = com.google.cloud.alloydb.v1.resources.ClusterView.CLUSTER_VIEW_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetClusterRequest] with Product with Serializable
Message for getting a Cluster
Message for getting a Cluster
- name
Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
- view
Optional. The view of the cluster to return. Returns all default fields if not set.
- Annotations
- @SerialVersionUID()
- final case class GetConnectionInfoRequest(parent: String = "", requestId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetConnectionInfoRequest] with Product with Serializable
Request message for GetConnectionInfo.
Request message for GetConnectionInfo.
- parent
Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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).
- Annotations
- @SerialVersionUID()
- final case class GetInstanceRequest(name: String = "", view: InstanceView = com.google.cloud.alloydb.v1.resources.InstanceView.INSTANCE_VIEW_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetInstanceRequest] with Product with Serializable
Message for getting a Instance
Message for getting a Instance
- name
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- view
The view of the instance to return.
- Annotations
- @SerialVersionUID()
- final case class GetUserRequest(name: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetUserRequest] with Product with Serializable
Message for getting a User
Message for getting a User
- name
Required. The name of the resource. For the required format, see the comment on the User.name field.
- Annotations
- @SerialVersionUID()
- final case class InjectFaultRequest(faultType: FaultType = com.google.cloud.alloydb.v1.service.InjectFaultRequest.FaultType.FAULT_TYPE_UNSPECIFIED, name: String = "", requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InjectFaultRequest] with Product with Serializable
Message for triggering fault injection on an instance
Message for triggering fault injection on an instance
- faultType
Required. The type of fault to be injected in an instance.
- name
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.
- Annotations
- @SerialVersionUID()
- final case class ListBackupsRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", orderBy: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListBackupsRequest] with Product with Serializable
Message for requesting list of Backups
Message for requesting list of Backups
- parent
Required. Parent value for ListBackupsRequest
- pageSize
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- pageToken
A token identifying a page of results the server should return.
- filter
Filtering results
- orderBy
Hint for how to order the results
- Annotations
- @SerialVersionUID()
- final case class ListBackupsResponse(backups: Seq[Backup] = _root_.scala.Seq.empty, nextPageToken: String = "", unreachable: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListBackupsResponse] with Product with Serializable
Message for response to listing Backups
Message for response to listing Backups
- backups
The list of Backup
- nextPageToken
A token identifying a page of results the server should return.
- unreachable
Locations that could not be reached.
- Annotations
- @SerialVersionUID()
- final case class ListClustersRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", orderBy: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListClustersRequest] with Product with Serializable
Message for requesting list of Clusters
Message for requesting list of Clusters
- parent
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/-
- pageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- pageToken
A token identifying a page of results the server should return.
- filter
Optional. Filtering results
- orderBy
Optional. Hint for how to order the results
- Annotations
- @SerialVersionUID()
- final case class ListClustersResponse(clusters: Seq[Cluster] = _root_.scala.Seq.empty, nextPageToken: String = "", unreachable: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListClustersResponse] with Product with Serializable
Message for response to listing Clusters
Message for response to listing Clusters
- clusters
The list of Cluster
- nextPageToken
A token identifying a page of results the server should return.
- unreachable
Locations that could not be reached.
- Annotations
- @SerialVersionUID()
- final case class ListInstancesRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", orderBy: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListInstancesRequest] with Product with Serializable
Message for requesting list of Instances
Message for requesting list of Instances
- parent
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/-
- pageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- pageToken
A token identifying a page of results the server should return.
- filter
Optional. Filtering results
- orderBy
Optional. Hint for how to order the results
- Annotations
- @SerialVersionUID()
- final case class ListInstancesResponse(instances: Seq[Instance] = _root_.scala.Seq.empty, nextPageToken: String = "", unreachable: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListInstancesResponse] with Product with Serializable
Message for response to listing Instances
Message for response to listing Instances
- instances
The list of Instance
- nextPageToken
A token identifying a page of results the server should return.
- unreachable
Locations that could not be reached.
- Annotations
- @SerialVersionUID()
- final case class ListSupportedDatabaseFlagsRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSupportedDatabaseFlagsRequest] with Product with Serializable
Message for listing the information about the supported Database flags.
Message for listing the information about the supported Database flags.
- parent
Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.
- pageSize
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- pageToken
A token identifying a page of results the server should return.
- Annotations
- @SerialVersionUID()
- final case class ListSupportedDatabaseFlagsResponse(supportedDatabaseFlags: Seq[SupportedDatabaseFlag] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSupportedDatabaseFlagsResponse] with Product with Serializable
Message for response to listing SupportedDatabaseFlags.
Message for response to listing SupportedDatabaseFlags.
- supportedDatabaseFlags
The list of SupportedDatabaseFlags.
- nextPageToken
A token identifying a page of results the server should return.
- Annotations
- @SerialVersionUID()
- final case class ListUsersRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", orderBy: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListUsersRequest] with Product with Serializable
Message for requesting list of Users
Message for requesting list of Users
- parent
Required. Parent value for ListUsersRequest
- pageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
- pageToken
Optional. A token identifying a page of results the server should return.
- filter
Optional. Filtering results
- orderBy
Optional. Hint for how to order the results
- Annotations
- @SerialVersionUID()
- final case class ListUsersResponse(users: Seq[User] = _root_.scala.Seq.empty, nextPageToken: String = "", unreachable: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListUsersResponse] with Product with Serializable
Message for response to listing Users
Message for response to listing Users
- users
The list of User
- nextPageToken
A token identifying a page of results the server should return.
- unreachable
Locations that could not be reached.
- Annotations
- @SerialVersionUID()
- final case class OperationMetadata(requestSpecific: RequestSpecific = com.google.cloud.alloydb.v1.service.OperationMetadata.RequestSpecific.Empty, createTime: Option[Timestamp] = _root_.scala.None, endTime: Option[Timestamp] = _root_.scala.None, target: String = "", verb: String = "", statusMessage: String = "", requestedCancellation: Boolean = false, apiVersion: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OperationMetadata] with Product with Serializable
Represents the metadata of the long-running operation.
Represents the metadata of the long-running operation.
- createTime
Output only. The time the operation was created.
- endTime
Output only. The time the operation finished running.
- target
Output only. Server-defined resource path for the target of the operation.
- verb
Output only. Name of the verb executed by the operation.
- statusMessage
Output only. Human-readable status of the operation, if any.
- requestedCancellation
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- apiVersion
Output only. API version used to start the operation.
- Annotations
- @SerialVersionUID()
- final case class PromoteClusterRequest(name: String = "", requestId: String = "", etag: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PromoteClusterRequest] with Product with Serializable
Message for promoting a Cluster
Message for promoting a Cluster
- name
Required. The name of the resource. For the required format, see the comment on the Cluster.name field
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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).
- etag
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.
- validateOnly
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
- Annotations
- @SerialVersionUID()
- final case class RestartInstanceRequest(name: String = "", requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RestartInstanceRequest] with Product with Serializable
- name
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.
- Annotations
- @SerialVersionUID()
- final case class RestoreClusterRequest(source: Source = com.google.cloud.alloydb.v1.service.RestoreClusterRequest.Source.Empty, parent: String = "", clusterId: String = "", cluster: Option[Cluster] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RestoreClusterRequest] with Product with Serializable
Message for restoring a Cluster from a backup or another cluster at a given point in time.
Message for restoring a Cluster from a backup or another cluster at a given point in time.
- parent
Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
- clusterId
Required. ID of the requesting object.
- cluster
Required. The resource being created
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.
- Annotations
- @SerialVersionUID()
- final case class UpdateBackupRequest(updateMask: Option[FieldMask] = _root_.scala.None, backup: Option[Backup] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, allowMissing: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateBackupRequest] with Product with Serializable
Message for updating a Backup
Message for updating a Backup
- updateMask
Optional. Field mask is used to specify the fields to be overwritten in the Backup 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.
- backup
Required. The resource being updated
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- allowMissing
Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and
update_maskis ignored.
- Annotations
- @SerialVersionUID()
- final case class UpdateClusterRequest(updateMask: Option[FieldMask] = _root_.scala.None, cluster: Option[Cluster] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, allowMissing: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateClusterRequest] with Product with Serializable
Message for updating a Cluster
Message for updating a Cluster
- updateMask
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.
- cluster
Required. The resource being updated
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
- allowMissing
Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and
update_maskis ignored.
- Annotations
- @SerialVersionUID()
- final case class UpdateInstanceRequest(updateMask: Option[FieldMask] = _root_.scala.None, instance: Option[Instance] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, allowMissing: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateInstanceRequest] with Product with Serializable
Message for updating a Instance
Message for updating a Instance
- updateMask
Optional. Field mask is used to specify the fields to be overwritten in the Instance 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.
- instance
Required. The resource being updated
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
- allowMissing
Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and
update_maskis ignored.
- Annotations
- @SerialVersionUID()
- final case class UpdateUserRequest(updateMask: Option[FieldMask] = _root_.scala.None, user: Option[User] = _root_.scala.None, requestId: String = "", validateOnly: Boolean = false, allowMissing: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateUserRequest] with Product with Serializable
Message for updating a User
Message for updating a User
- updateMask
Optional. Field mask is used to specify the fields to be overwritten in the User 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.
- user
Required. The resource being updated
- requestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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
Optional. If set, the backend validates the request, but doesn't actually execute it.
- allowMissing
Optional. Allow missing fields in the update mask.
- Annotations
- @SerialVersionUID()
Value Members
- object AlloyDBAdmin
- object BatchCreateInstanceStatus extends GeneratedMessageCompanion[BatchCreateInstanceStatus]
- object BatchCreateInstancesMetadata extends GeneratedMessageCompanion[BatchCreateInstancesMetadata]
- object BatchCreateInstancesRequest extends GeneratedMessageCompanion[BatchCreateInstancesRequest]
- object BatchCreateInstancesResponse extends GeneratedMessageCompanion[BatchCreateInstancesResponse]
- object CreateBackupRequest extends GeneratedMessageCompanion[CreateBackupRequest]
- object CreateClusterRequest extends GeneratedMessageCompanion[CreateClusterRequest]
- object CreateInstanceRequest extends GeneratedMessageCompanion[CreateInstanceRequest]
- object CreateInstanceRequests extends GeneratedMessageCompanion[CreateInstanceRequests]
- object CreateSecondaryClusterRequest extends GeneratedMessageCompanion[CreateSecondaryClusterRequest]
- object CreateSecondaryInstanceRequest extends GeneratedMessageCompanion[CreateSecondaryInstanceRequest]
- object CreateUserRequest extends GeneratedMessageCompanion[CreateUserRequest]
- object DeleteBackupRequest extends GeneratedMessageCompanion[DeleteBackupRequest]
- object DeleteClusterRequest extends GeneratedMessageCompanion[DeleteClusterRequest]
- object DeleteInstanceRequest extends GeneratedMessageCompanion[DeleteInstanceRequest]
- object DeleteUserRequest extends GeneratedMessageCompanion[DeleteUserRequest]
- object FailoverInstanceRequest extends GeneratedMessageCompanion[FailoverInstanceRequest]
- object GenerateClientCertificateRequest extends GeneratedMessageCompanion[GenerateClientCertificateRequest]
- object GenerateClientCertificateResponse extends GeneratedMessageCompanion[GenerateClientCertificateResponse]
- object GetBackupRequest extends GeneratedMessageCompanion[GetBackupRequest]
- object GetClusterRequest extends GeneratedMessageCompanion[GetClusterRequest]
- object GetConnectionInfoRequest extends GeneratedMessageCompanion[GetConnectionInfoRequest]
- object GetInstanceRequest extends GeneratedMessageCompanion[GetInstanceRequest]
- object GetUserRequest extends GeneratedMessageCompanion[GetUserRequest]
- object InjectFaultRequest extends GeneratedMessageCompanion[InjectFaultRequest]
- object ListBackupsRequest extends GeneratedMessageCompanion[ListBackupsRequest]
- object ListBackupsResponse extends GeneratedMessageCompanion[ListBackupsResponse]
- object ListClustersRequest extends GeneratedMessageCompanion[ListClustersRequest]
- object ListClustersResponse extends GeneratedMessageCompanion[ListClustersResponse]
- object ListInstancesRequest extends GeneratedMessageCompanion[ListInstancesRequest]
- object ListInstancesResponse extends GeneratedMessageCompanion[ListInstancesResponse]
- object ListSupportedDatabaseFlagsRequest extends GeneratedMessageCompanion[ListSupportedDatabaseFlagsRequest]
- object ListSupportedDatabaseFlagsResponse extends GeneratedMessageCompanion[ListSupportedDatabaseFlagsResponse]
- object ListUsersRequest extends GeneratedMessageCompanion[ListUsersRequest]
- object ListUsersResponse extends GeneratedMessageCompanion[ListUsersResponse]
- object OperationMetadata extends GeneratedMessageCompanion[OperationMetadata]
- object PromoteClusterRequest extends GeneratedMessageCompanion[PromoteClusterRequest]
- object RestartInstanceRequest extends GeneratedMessageCompanion[RestartInstanceRequest]
- object RestoreClusterRequest extends GeneratedMessageCompanion[RestoreClusterRequest]
- object ServiceProto extends GeneratedFileObject
- object UpdateBackupRequest extends GeneratedMessageCompanion[UpdateBackupRequest]
- object UpdateClusterRequest extends GeneratedMessageCompanion[UpdateClusterRequest]
- object UpdateInstanceRequest extends GeneratedMessageCompanion[UpdateInstanceRequest]
- object UpdateUserRequest extends GeneratedMessageCompanion[UpdateUserRequest]