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:
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateCluster(NoAwaitTag, std::string const &, google::cloud::alloydb::v1::Cluster const &, std::string const &, Options)
Creates a new Cluster in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
cluster |
google::cloud::alloydb::v1::Cluster const &
|
cluster_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateCluster(NoAwaitTag, google::cloud::alloydb::v1::CreateClusterRequest const &, Options)
Creates a new Cluster in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::CreateClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCluster(google::longrunning::Operation const &, Options)
Creates a new Cluster in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 > > |
A |
UpdateCluster(NoAwaitTag, google::cloud::alloydb::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
cluster |
google::cloud::alloydb::v1::Cluster const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateCluster(NoAwaitTag, google::cloud::alloydb::v1::UpdateClusterRequest const &, Options)
Updates the parameters of a single Cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::UpdateClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCluster(google::longrunning::Operation const &, Options)
Updates the parameters of a single Cluster.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 |
DeleteCluster(NoAwaitTag, std::string const &, Options)
Deletes a single Cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteCluster(NoAwaitTag, google::cloud::alloydb::v1::DeleteClusterRequest const &, Options)
Deletes a single Cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::DeleteClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCluster(google::longrunning::Operation const &, Options)
Deletes a single Cluster.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > > |
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 > > |
A |
PromoteCluster(NoAwaitTag, std::string const &, Options)
Promotes a SECONDARY cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
PromoteCluster(NoAwaitTag, google::cloud::alloydb::v1::PromoteClusterRequest const &, Options)
Promotes a SECONDARY cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::PromoteClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
PromoteCluster(google::longrunning::Operation const &, Options)
Promotes a SECONDARY cluster.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Cluster > > |
SwitchoverCluster(std::string const &, Options)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
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 > > |
A |
SwitchoverCluster(NoAwaitTag, std::string const &, Options)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SwitchoverCluster(google::cloud::alloydb::v1::SwitchoverClusterRequest const &, Options)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::alloydb::v1::SwitchoverClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
SwitchoverCluster(NoAwaitTag, google::cloud::alloydb::v1::SwitchoverClusterRequest const &, Options)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::SwitchoverClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SwitchoverCluster(google::longrunning::Operation const &, Options)
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 |
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 |
RestoreCluster(NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::RestoreClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreCluster(google::longrunning::Operation 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.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 > > |
A |
CreateSecondaryCluster(NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
cluster |
google::cloud::alloydb::v1::Cluster const &
|
cluster_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateSecondaryCluster(NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &, Options)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::CreateSecondaryClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSecondaryCluster(google::longrunning::Operation const &, Options)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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:
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateInstance(NoAwaitTag, std::string const &, google::cloud::alloydb::v1::Instance const &, std::string const &, Options)
Creates a new Instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
instance |
google::cloud::alloydb::v1::Instance const &
|
instance_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateInstance(NoAwaitTag, google::cloud::alloydb::v1::CreateInstanceRequest const &, Options)
Creates a new Instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::CreateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::longrunning::Operation const &, Options)
Creates a new Instance in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
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 |
CreateSecondaryInstance(NoAwaitTag, std::string const &, google::cloud::alloydb::v1::Instance const &, std::string const &, Options)
Creates a new SECONDARY Instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
instance |
google::cloud::alloydb::v1::Instance const &
|
instance_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateSecondaryInstance(NoAwaitTag, google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &, Options)
Creates a new SECONDARY Instance in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::CreateSecondaryInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSecondaryInstance(google::longrunning::Operation const &, Options)
Creates a new SECONDARY Instance in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
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 |
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 |
BatchCreateInstances(NoAwaitTag, google::cloud::alloydb::v1::BatchCreateInstancesRequest const &, Options)
Creates new instances under the given project, location and cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::BatchCreateInstancesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BatchCreateInstances(google::longrunning::Operation const &, Options)
Creates new instances under the given project, location and cluster.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::BatchCreateInstancesResponse > > |
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 |
UpdateInstance(NoAwaitTag, google::cloud::alloydb::v1::Instance const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
instance |
google::cloud::alloydb::v1::Instance const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateInstance(NoAwaitTag, google::cloud::alloydb::v1::UpdateInstanceRequest const &, Options)
Updates the parameters of a single Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::UpdateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(google::longrunning::Operation const &, Options)
Updates the parameters of a single Instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
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 |
DeleteInstance(NoAwaitTag, std::string const &, Options)
Deletes a single Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteInstance(NoAwaitTag, google::cloud::alloydb::v1::DeleteInstanceRequest const &, Options)
Deletes a single Instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::DeleteInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteInstance(google::longrunning::Operation const &, Options)
Deletes a single Instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > > |
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 |
FailoverInstance(NoAwaitTag, std::string const &, Options)
Forces a Failover for a highly available instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
FailoverInstance(NoAwaitTag, google::cloud::alloydb::v1::FailoverInstanceRequest const &, Options)
Forces a Failover for a highly available instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::FailoverInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
FailoverInstance(google::longrunning::Operation const &, Options)
Forces a Failover for a highly available instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
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 |
InjectFault(NoAwaitTag, google::cloud::alloydb::v1::InjectFaultRequest::FaultType, std::string const &, Options)
Injects fault in an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
fault_type |
google::cloud::alloydb::v1::InjectFaultRequest::FaultType
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
InjectFault(NoAwaitTag, google::cloud::alloydb::v1::InjectFaultRequest const &, Options)
Injects fault in an instance.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::InjectFaultRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
InjectFault(google::longrunning::Operation const &, Options)
Injects fault in an instance.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
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 |
RestartInstance(NoAwaitTag, std::string const &, Options)
Restart an Instance in a cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
RestartInstance(NoAwaitTag, google::cloud::alloydb::v1::RestartInstanceRequest const &, Options)
Restart an Instance in a cluster.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::RestartInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestartInstance(google::longrunning::Operation const &, Options)
Restart an Instance in a cluster.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Instance > > |
ExecuteSql(std::string const &, std::string const &, std::string const &, std::string const &, std::string const &, Options)
Executes a SQL statement in a database inside an AlloyDB instance.
@param instance Required. The instance where the SQL will be executed. For the required
format, see the comment on the Instance.name field.
@param database Required. Name of the database where the query will be executed.
Note - Value provided should be the same as expected from `SELECT
``` / current_database();`and NOT as a resource reference. @param user Required. Database user to be used for executing the SQL. Note - Value provided should be the same as expected from `SELECT current_user;`and NOT as a resource reference. @param sql_statement Required. SQL statement to execute on database. Any valid statement is permitted, including DDL, DML, DQL statements. @param password Optional. The database native user’s password. @param opts Optional. Override the class-level options, such as retry and backoff policies. @return the result of the RPC. The response message type ([google.cloud.alloydb.v1.ExecuteSqlResponse]) is mapped to a C++ class using the [Protobuf mapping rules]. If the request fails, the [`StatusOr`] contains the error details.
Parameters | |
---|---|
Name | Description |
instance |
std::string const &
|
database |
std::string const &
|
user |
std::string const &
|
sql_statement |
std::string const &
|
password |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::alloydb::v1::ExecuteSqlResponse > |
ExecuteSql(google::cloud::alloydb::v1::ExecuteSqlRequest const &, Options)
Executes a SQL statement in a database inside an AlloyDB instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::alloydb::v1::ExecuteSqlRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::alloydb::v1::ExecuteSqlResponse > |
the result of the RPC. The response message type (google.cloud.alloydb.v1.ExecuteSqlResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateBackup(NoAwaitTag, std::string const &, google::cloud::alloydb::v1::Backup const &, std::string const &, Options)
Creates a new Backup in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
backup |
google::cloud::alloydb::v1::Backup const &
|
backup_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateBackup(NoAwaitTag, google::cloud::alloydb::v1::CreateBackupRequest const &, Options)
Creates a new Backup in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::CreateBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackup(google::longrunning::Operation const &, Options)
Creates a new Backup in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Backup > > |
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 |
UpdateBackup(NoAwaitTag, google::cloud::alloydb::v1::Backup const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
backup |
google::cloud::alloydb::v1::Backup const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateBackup(NoAwaitTag, google::cloud::alloydb::v1::UpdateBackupRequest const &, Options)
Updates the parameters of a single Backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::UpdateBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBackup(google::longrunning::Operation const &, Options)
Updates the parameters of a single Backup.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::Backup > > |
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 |
DeleteBackup(NoAwaitTag, std::string const &, Options)
Deletes a single Backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteBackup(NoAwaitTag, google::cloud::alloydb::v1::DeleteBackupRequest const &, Options)
Deletes a single Backup.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::alloydb::v1::DeleteBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackup(google::longrunning::Operation const &, Options)
Deletes a single Backup.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::alloydb::v1::OperationMetadata > > |
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:
|
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 |
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 |
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 |
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:
|
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 |
GenerateClientCertificate(google::cloud::alloydb::v1::GenerateClientCertificateRequest 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 |
request |
google::cloud::alloydb::v1::GenerateClientCertificateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ListDatabases(std::string const &, Options)
Lists Databases in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListDatabasesRequest. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::alloydb::v1::Database > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDatabases(google::cloud::alloydb::v1::ListDatabasesRequest, Options)
Lists Databases in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::alloydb::v1::ListDatabasesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::alloydb::v1::Database > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |