Class AlloyDBAdminClient (2.20.0)

Service describing handlers for resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

AlloyDBAdminClient(AlloyDBAdminClient const &)

Copy and move support

Parameter
Name	Description
	`AlloyDBAdminClient const &`

AlloyDBAdminClient(AlloyDBAdminClient &&)

Copy and move support

Parameter
Name	Description
	`AlloyDBAdminClient &&`

AlloyDBAdminClient(std::shared_ptr< AlloyDBAdminConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< AlloyDBAdminConnection >`
`opts`	`Options`

Operators

operator=(AlloyDBAdminClient const &)

Copy and move support

Parameter
Name	Description
	`AlloyDBAdminClient const &`

Returns
Type	Description
`AlloyDBAdminClient &`

operator=(AlloyDBAdminClient &&)

Copy and move support

Parameter
Name	Description
	`AlloyDBAdminClient &&`

Returns
Type	Description
`AlloyDBAdminClient &`

Functions

ListClusters(std::string const &, Options)

Lists Clusters in a given project and location.

Parameters

Name Description

parent

std::string const &

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/-

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Cluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListClusters(google::cloud::alloydb::v1::ListClustersRequest, Options)

Lists Clusters in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::ListClustersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.ListClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Cluster >

GetCluster(std::string const &, Options)

Gets details of a single Cluster.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Cluster >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCluster(google::cloud::alloydb::v1::GetClusterRequest const &, Options)

Gets details of a single Cluster.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GetClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GetClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Cluster >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateCluster(std::string const &, google::cloud::alloydb::v1::Cluster const &, std::string const &, Options)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
`cluster`	`google::cloud::alloydb::v1::Cluster const &` Required. The resource being created
`cluster_id`	`std::string const &` Required. ID of the requesting object.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCluster(google::cloud::alloydb::v1::CreateClusterRequest const &, Options)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

UpdateCluster(google::cloud::alloydb::v1::Cluster const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Cluster.

Parameters
Name	Description
`cluster`	`google::cloud::alloydb::v1::Cluster const &` Required. The resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

UpdateCluster(google::cloud::alloydb::v1::UpdateClusterRequest const &, Options)

Updates the parameters of a single Cluster.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::UpdateClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.UpdateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

DeleteCluster(std::string const &, Options)

Deletes a single Cluster.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCluster(google::cloud::alloydb::v1::DeleteClusterRequest const &, Options)

Deletes a single Cluster.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::DeleteClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.DeleteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PromoteCluster(std::string const &, Options)

Promotes a SECONDARY cluster.

This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Cluster.name field
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

PromoteCluster(google::cloud::alloydb::v1::PromoteClusterRequest const &, Options)

Promotes a SECONDARY cluster.

This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::PromoteClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.PromoteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

RestoreCluster(google::cloud::alloydb::v1::RestoreClusterRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::RestoreClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.RestoreClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

CreateSecondaryCluster(std::string const &, google::cloud::alloydb::v1::Cluster const &, std::string const &, Options)

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
`cluster`	`google::cloud::alloydb::v1::Cluster const &` Required. Configuration of the requesting object (the secondary cluster).
`cluster_id`	`std::string const &` Required. ID of the requesting object (the secondary cluster).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

CreateSecondaryCluster(google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &, Options)

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateSecondaryClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Cluster > >

ListInstances(std::string const &, Options)

Lists Instances in a given project and location.

Parameters

Name Description

parent

std::string const &

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/-

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Instance >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInstances(google::cloud::alloydb::v1::ListInstancesRequest, Options)

Lists Instances in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::ListInstancesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.ListInstancesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Instance >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInstance(std::string const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Instance.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Instance >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInstance(google::cloud::alloydb::v1::GetInstanceRequest const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GetInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GetInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Instance >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateInstance(std::string const &, google::cloud::alloydb::v1::Instance const &, std::string const &, Options)

Creates a new Instance in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
`instance`	`google::cloud::alloydb::v1::Instance const &` Required. The resource being created
`instance_id`	`std::string const &` Required. ID of the requesting object.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInstance(google::cloud::alloydb::v1::CreateInstanceRequest const &, Options)

Creates a new Instance in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSecondaryInstance(std::string const &, google::cloud::alloydb::v1::Instance const &, std::string const &, Options)

Creates a new SECONDARY Instance in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
`instance`	`google::cloud::alloydb::v1::Instance const &` Required. The resource being created
`instance_id`	`std::string const &` Required. ID of the requesting object.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSecondaryInstance(google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &, Options)

Creates a new SECONDARY Instance in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateSecondaryInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateInstances(google::cloud::alloydb::v1::BatchCreateInstancesRequest const &, Options)

Creates new instances under the given project, location and cluster.

There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::BatchCreateInstancesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.BatchCreateInstancesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::BatchCreateInstancesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.BatchCreateInstancesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInstance(google::cloud::alloydb::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Instance.

Parameters
Name	Description
`instance`	`google::cloud::alloydb::v1::Instance const &` Required. The resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInstance(google::cloud::alloydb::v1::UpdateInstanceRequest const &, Options)

Updates the parameters of a single Instance.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::UpdateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.UpdateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(std::string const &, Options)

Deletes a single Instance.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Instance.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(google::cloud::alloydb::v1::DeleteInstanceRequest const &, Options)

Deletes a single Instance.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::DeleteInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.DeleteInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FailoverInstance(std::string const &, Options)

Forces a Failover for a highly available instance.

Failover promotes the HA standby instance as the new primary. Imperative only.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Instance.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FailoverInstance(google::cloud::alloydb::v1::FailoverInstanceRequest const &, Options)

Forces a Failover for a highly available instance.

Failover promotes the HA standby instance as the new primary. Imperative only.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::FailoverInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.FailoverInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InjectFault(google::cloud::alloydb::v1::InjectFaultRequest::FaultType, std::string const &, Options)

Injects fault in an instance.

Imperative only.

Parameters
Name	Description
`fault_type`	`google::cloud::alloydb::v1::InjectFaultRequest::FaultType` Required. The type of fault to be injected in an instance.
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Instance.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InjectFault(google::cloud::alloydb::v1::InjectFaultRequest const &, Options)

Injects fault in an instance.

Imperative only.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::InjectFaultRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.InjectFaultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestartInstance(std::string const &, Options)

Restart an Instance in a cluster.

Imperative only.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the Instance.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestartInstance(google::cloud::alloydb::v1::RestartInstanceRequest const &, Options)

Restart an Instance in a cluster.

Imperative only.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::RestartInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.RestartInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListBackups(std::string const &, Options)

Lists Backups in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListBackupsRequest
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Backup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListBackups(google::cloud::alloydb::v1::ListBackupsRequest, Options)

Lists Backups in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::ListBackupsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.ListBackupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::Backup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetBackup(std::string const &, Options)

Gets details of a single Backup.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Backup >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetBackup(google::cloud::alloydb::v1::GetBackupRequest const &, Options)

Gets details of a single Backup.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GetBackupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GetBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::Backup >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateBackup(std::string const &, google::cloud::alloydb::v1::Backup const &, std::string const &, Options)

Creates a new Backup in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Value for parent.
`backup`	`google::cloud::alloydb::v1::Backup const &` Required. The resource being created
`backup_id`	`std::string const &` Required. ID of the requesting object.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Backup > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackup(google::cloud::alloydb::v1::CreateBackupRequest const &, Options)

Creates a new Backup in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateBackupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Backup > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(google::cloud::alloydb::v1::Backup const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Backup.

Parameters
Name	Description
`backup`	`google::cloud::alloydb::v1::Backup const &` Required. The resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Backup > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(google::cloud::alloydb::v1::UpdateBackupRequest const &, Options)

Updates the parameters of a single Backup.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::UpdateBackupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.UpdateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::Backup > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackup(std::string const &, Options)

Deletes a single Backup.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource. For the required format, see the comment on the Backup.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackup(google::cloud::alloydb::v1::DeleteBackupRequest const &, Options)

Deletes a single Backup.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::DeleteBackupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.DeleteBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.alloydb.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListSupportedDatabaseFlags(std::string const &, Options)

Lists SupportedDatabaseFlags for a given project and location.

Parameters

Name Description

parent

std::string const &

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.

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::SupportedDatabaseFlag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.SupportedDatabaseFlag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSupportedDatabaseFlags(google::cloud::alloydb::v1::ListSupportedDatabaseFlagsRequest, Options)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::ListSupportedDatabaseFlagsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.ListSupportedDatabaseFlagsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::SupportedDatabaseFlag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.SupportedDatabaseFlag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GenerateClientCertificate(std::string const &, Options)

Generate a client certificate signed by a Cluster CA.

The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

Parameters

Name Description

parent

std::string const &

Required. The name of the parent resource. The required format is:

projects/{project}/locations/{location}/clusters/{cluster}

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::GenerateClientCertificateResponse >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.GenerateClientCertificateResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GenerateClientCertificate(google::cloud::alloydb::v1::GenerateClientCertificateRequest const &, Options)

Generate a client certificate signed by a Cluster CA.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GenerateClientCertificateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GenerateClientCertificateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::GenerateClientCertificateResponse >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.GenerateClientCertificateResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetConnectionInfo(std::string const &, Options)

Get instance metadata used for a connection.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::ConnectionInfo >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.ConnectionInfo) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetConnectionInfo(google::cloud::alloydb::v1::GetConnectionInfoRequest const &, Options)

Get instance metadata used for a connection.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GetConnectionInfoRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GetConnectionInfoRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::ConnectionInfo >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.ConnectionInfo) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListUsers(std::string const &, Options)

Lists Users in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListUsersRequest
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::User >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.User, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListUsers(google::cloud::alloydb::v1::ListUsersRequest, Options)

Lists Users in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::ListUsersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.ListUsersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::alloydb::v1::User >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.alloydb.v1.User, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetUser(std::string const &, Options)

Gets details of a single User.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the User.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetUser(google::cloud::alloydb::v1::GetUserRequest const &, Options)

Gets details of a single User.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::GetUserRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.GetUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateUser(std::string const &, google::cloud::alloydb::v1::User const &, std::string const &, Options)

Creates a new User in a given project, location, and cluster.

Parameters
Name	Description
`parent`	`std::string const &` Required. Value for parent.
`user`	`google::cloud::alloydb::v1::User const &` Required. The resource being created
`user_id`	`std::string const &` Required. ID of the requesting object.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateUser(google::cloud::alloydb::v1::CreateUserRequest const &, Options)

Creates a new User in a given project, location, and cluster.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::CreateUserRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.CreateUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateUser(google::cloud::alloydb::v1::User const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single User.

Parameters
Name	Description
`user`	`google::cloud::alloydb::v1::User const &` Required. The resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateUser(google::cloud::alloydb::v1::UpdateUserRequest const &, Options)

Updates the parameters of a single User.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::UpdateUserRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.UpdateUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::alloydb::v1::User >`	the result of the RPC. The response message type (google.cloud.alloydb.v1.User) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteUser(std::string const &, Options)

Deletes a single User.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the resource. For the required format, see the comment on the User.name field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteUser(google::cloud::alloydb::v1::DeleteUserRequest const &, Options)

Deletes a single User.

Parameters
Name	Description
`request`	`google::cloud::alloydb::v1::DeleteUserRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.alloydb.v1.DeleteUserRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.