Class EdgeContainerClient (2.32.0)

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

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

EdgeContainerClient(EdgeContainerClient const &)

Copy and move support

Parameter
Name Description
EdgeContainerClient const &

EdgeContainerClient(EdgeContainerClient &&)

Copy and move support

Parameter
Name Description
EdgeContainerClient &&

EdgeContainerClient(std::shared_ptr< EdgeContainerConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< EdgeContainerConnection >
opts Options

Operators

operator=(EdgeContainerClient const &)

Copy and move support

Parameter
Name Description
EdgeContainerClient const &
Returns
Type Description
EdgeContainerClient &

operator=(EdgeContainerClient &&)

Copy and move support

Parameter
Name Description
EdgeContainerClient &&
Returns
Type Description
EdgeContainerClient &

Functions

ListClusters(std::string const &, Options)

Lists Clusters in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent location, which owns this collection of clusters.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::v1::ListClustersRequest, Options)

Lists Clusters in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::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.edgecontainer.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.

GetCluster(std::string const &, Options)

Gets details of a single Cluster.

Parameters
Name Description
name std::string const &

Required. The resource name of the cluster.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::Cluster >

the result of the RPC. The response message type (google.cloud.edgecontainer.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::edgecontainer::v1::GetClusterRequest const &, Options)

Gets details of a single Cluster.

Parameters
Name Description
request google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::v1::Cluster >

the result of the RPC. The response message type (google.cloud.edgecontainer.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::edgecontainer::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 parent location where this cluster will be created.

cluster google::cloud::edgecontainer::v1::Cluster const &

Required. The cluster to create.

cluster_id std::string const &

Required. A client-specified unique identifier for the cluster.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCluster(NoAwaitTag, std::string const &, google::cloud::edgecontainer::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::edgecontainer::v1::Cluster const &
cluster_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Cluster in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCluster(NoAwaitTag, google::cloud::edgecontainer::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::edgecontainer::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::edgecontainer::v1::Cluster > >

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

Updates the parameters of a single Cluster.

Parameters
Name Description
cluster google::cloud::edgecontainer::v1::Cluster const &

The updated cluster.

update_mask google::protobuf::FieldMask const &

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::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCluster(NoAwaitTag, google::cloud::edgecontainer::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::edgecontainer::v1::Cluster const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of a single Cluster.

Parameters
Name Description
request google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCluster(NoAwaitTag, google::cloud::edgecontainer::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::edgecontainer::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::edgecontainer::v1::Cluster > >

UpgradeCluster(std::string const &, std::string const &, google::cloud::edgecontainer::v1::UpgradeClusterRequest::Schedule, Options)

Upgrades a single cluster.

Parameters
Name Description
name std::string const &

Required. The resource name of the cluster.

target_version std::string const &

Required. The version the cluster is going to be upgraded to.

schedule google::cloud::edgecontainer::v1::UpgradeClusterRequest::Schedule

The schedule for the upgrade.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeCluster(NoAwaitTag, std::string const &, std::string const &, google::cloud::edgecontainer::v1::UpgradeClusterRequest::Schedule, Options)

Upgrades 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 &
target_version std::string const &
schedule google::cloud::edgecontainer::v1::UpgradeClusterRequest::Schedule
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpgradeCluster(google::cloud::edgecontainer::v1::UpgradeClusterRequest const &, Options)

Upgrades a single cluster.

Parameters
Name Description
request google::cloud::edgecontainer::v1::UpgradeClusterRequest 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.edgecontainer.v1.UpgradeClusterRequest. 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::edgecontainer::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.edgecontainer.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeCluster(NoAwaitTag, google::cloud::edgecontainer::v1::UpgradeClusterRequest const &, Options)

Upgrades 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::edgecontainer::v1::UpgradeClusterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpgradeCluster(google::longrunning::Operation const &, Options)

Upgrades 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::edgecontainer::v1::Cluster > >

DeleteCluster(std::string const &, Options)

Deletes a single Cluster.

Parameters
Name Description
name std::string const &

Required. The resource name of the cluster.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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::edgecontainer::v1::DeleteClusterRequest const &, Options)

Deletes a single Cluster.

Parameters
Name Description
request google::cloud::edgecontainer::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.edgecontainer.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::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCluster(NoAwaitTag, google::cloud::edgecontainer::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::edgecontainer::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::edgecontainer::v1::OperationMetadata > >

GenerateAccessToken(std::string const &, Options)

Generates an access token for a Cluster.

Parameters
Name Description
cluster std::string const &

Required. The resource name of the cluster.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::GenerateAccessTokenResponse >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.GenerateAccessTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateAccessToken(google::cloud::edgecontainer::v1::GenerateAccessTokenRequest const &, Options)

Generates an access token for a Cluster.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GenerateAccessTokenRequest 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.edgecontainer.v1.GenerateAccessTokenRequest. 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::edgecontainer::v1::GenerateAccessTokenResponse >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.GenerateAccessTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateOfflineCredential(std::string const &, Options)

Generates an offline credential for a Cluster.

Parameters
Name Description
cluster std::string const &

Required. The resource name of the cluster.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::GenerateOfflineCredentialResponse >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.GenerateOfflineCredentialResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateOfflineCredential(google::cloud::edgecontainer::v1::GenerateOfflineCredentialRequest const &, Options)

Generates an offline credential for a Cluster.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GenerateOfflineCredentialRequest 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.edgecontainer.v1.GenerateOfflineCredentialRequest. 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::edgecontainer::v1::GenerateOfflineCredentialResponse >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.GenerateOfflineCredentialResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNodePools(std::string const &, Options)

Lists NodePools in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent cluster, which owns this collection of node pools.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::edgecontainer::v1::NodePool >

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.edgecontainer.v1.NodePool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNodePools(google::cloud::edgecontainer::v1::ListNodePoolsRequest, Options)

Lists NodePools in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::v1::ListNodePoolsRequest

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.edgecontainer.v1.ListNodePoolsRequest. 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::edgecontainer::v1::NodePool >

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.edgecontainer.v1.NodePool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetNodePool(std::string const &, Options)

Gets details of a single NodePool.

Parameters
Name Description
name std::string const &

Required. The resource name of the node pool.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::NodePool >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.NodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNodePool(google::cloud::edgecontainer::v1::GetNodePoolRequest const &, Options)

Gets details of a single NodePool.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GetNodePoolRequest 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.edgecontainer.v1.GetNodePoolRequest. 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::edgecontainer::v1::NodePool >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.NodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateNodePool(std::string const &, google::cloud::edgecontainer::v1::NodePool const &, std::string const &, Options)

Creates a new NodePool in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent cluster where this node pool will be created.

node_pool google::cloud::edgecontainer::v1::NodePool const &

Required. The node pool to create.

node_pool_id std::string const &

Required. A client-specified unique identifier for the node pool.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::v1::NodePool > >

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.edgecontainer.v1.NodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateNodePool(NoAwaitTag, std::string const &, google::cloud::edgecontainer::v1::NodePool const &, std::string const &, Options)

Creates a new NodePool 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 &
node_pool google::cloud::edgecontainer::v1::NodePool const &
node_pool_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateNodePool(google::cloud::edgecontainer::v1::CreateNodePoolRequest const &, Options)

Creates a new NodePool in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::v1::CreateNodePoolRequest 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.edgecontainer.v1.CreateNodePoolRequest. 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::edgecontainer::v1::NodePool > >

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.edgecontainer.v1.NodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateNodePool(NoAwaitTag, google::cloud::edgecontainer::v1::CreateNodePoolRequest const &, Options)

Creates a new NodePool 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::edgecontainer::v1::CreateNodePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateNodePool(google::longrunning::Operation const &, Options)

Creates a new NodePool 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::edgecontainer::v1::NodePool > >

UpdateNodePool(google::cloud::edgecontainer::v1::NodePool const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single NodePool.

Parameters
Name Description
node_pool google::cloud::edgecontainer::v1::NodePool const &

The updated node pool.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the NodePool 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::edgecontainer::v1::NodePool > >

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.edgecontainer.v1.NodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateNodePool(NoAwaitTag, google::cloud::edgecontainer::v1::NodePool const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single NodePool.

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
node_pool google::cloud::edgecontainer::v1::NodePool const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateNodePool(google::cloud::edgecontainer::v1::UpdateNodePoolRequest const &, Options)

Updates the parameters of a single NodePool.

Parameters
Name Description
request google::cloud::edgecontainer::v1::UpdateNodePoolRequest 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.edgecontainer.v1.UpdateNodePoolRequest. 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::edgecontainer::v1::NodePool > >

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.edgecontainer.v1.NodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateNodePool(NoAwaitTag, google::cloud::edgecontainer::v1::UpdateNodePoolRequest const &, Options)

Updates the parameters of a single NodePool.

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::edgecontainer::v1::UpdateNodePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateNodePool(google::longrunning::Operation const &, Options)

Updates the parameters of a single NodePool.

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::edgecontainer::v1::NodePool > >

DeleteNodePool(std::string const &, Options)

Deletes a single NodePool.

Parameters
Name Description
name std::string const &

Required. The resource name of the node pool.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteNodePool(NoAwaitTag, std::string const &, Options)

Deletes a single NodePool.

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 >

DeleteNodePool(google::cloud::edgecontainer::v1::DeleteNodePoolRequest const &, Options)

Deletes a single NodePool.

Parameters
Name Description
request google::cloud::edgecontainer::v1::DeleteNodePoolRequest 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.edgecontainer.v1.DeleteNodePoolRequest. 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::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteNodePool(NoAwaitTag, google::cloud::edgecontainer::v1::DeleteNodePoolRequest const &, Options)

Deletes a single NodePool.

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::edgecontainer::v1::DeleteNodePoolRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteNodePool(google::longrunning::Operation const &, Options)

Deletes a single NodePool.

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::edgecontainer::v1::OperationMetadata > >

ListMachines(std::string const &, Options)

Lists Machines in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent site, which owns this collection of machines.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::edgecontainer::v1::Machine >

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.edgecontainer.v1.Machine, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMachines(google::cloud::edgecontainer::v1::ListMachinesRequest, Options)

Lists Machines in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::v1::ListMachinesRequest

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.edgecontainer.v1.ListMachinesRequest. 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::edgecontainer::v1::Machine >

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.edgecontainer.v1.Machine, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetMachine(std::string const &, Options)

Gets details of a single Machine.

Parameters
Name Description
name std::string const &

Required. The resource name of the machine.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::Machine >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.Machine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMachine(google::cloud::edgecontainer::v1::GetMachineRequest const &, Options)

Gets details of a single Machine.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GetMachineRequest 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.edgecontainer.v1.GetMachineRequest. 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::edgecontainer::v1::Machine >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.Machine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListVpnConnections(std::string const &, Options)

Lists VPN connections in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent location, which owns this collection of VPN connections.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::edgecontainer::v1::VpnConnection >

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.edgecontainer.v1.VpnConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListVpnConnections(google::cloud::edgecontainer::v1::ListVpnConnectionsRequest, Options)

Lists VPN connections in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::v1::ListVpnConnectionsRequest

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.edgecontainer.v1.ListVpnConnectionsRequest. 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::edgecontainer::v1::VpnConnection >

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.edgecontainer.v1.VpnConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetVpnConnection(std::string const &, Options)

Gets details of a single VPN connection.

Parameters
Name Description
name std::string const &

Required. The resource name of the vpn connection.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::VpnConnection >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.VpnConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetVpnConnection(google::cloud::edgecontainer::v1::GetVpnConnectionRequest const &, Options)

Gets details of a single VPN connection.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GetVpnConnectionRequest 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.edgecontainer.v1.GetVpnConnectionRequest. 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::edgecontainer::v1::VpnConnection >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.VpnConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateVpnConnection(std::string const &, google::cloud::edgecontainer::v1::VpnConnection const &, std::string const &, Options)

Creates a new VPN connection in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent location where this vpn connection will be created.

vpn_connection google::cloud::edgecontainer::v1::VpnConnection const &

Required. The VPN connection to create.

vpn_connection_id std::string const &

Required. The VPN connection identifier.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::v1::VpnConnection > >

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.edgecontainer.v1.VpnConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVpnConnection(NoAwaitTag, std::string const &, google::cloud::edgecontainer::v1::VpnConnection const &, std::string const &, Options)

Creates a new VPN connection 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 &
vpn_connection google::cloud::edgecontainer::v1::VpnConnection const &
vpn_connection_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateVpnConnection(google::cloud::edgecontainer::v1::CreateVpnConnectionRequest const &, Options)

Creates a new VPN connection in a given project and location.

Parameters
Name Description
request google::cloud::edgecontainer::v1::CreateVpnConnectionRequest 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.edgecontainer.v1.CreateVpnConnectionRequest. 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::edgecontainer::v1::VpnConnection > >

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.edgecontainer.v1.VpnConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateVpnConnection(NoAwaitTag, google::cloud::edgecontainer::v1::CreateVpnConnectionRequest const &, Options)

Creates a new VPN connection 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::edgecontainer::v1::CreateVpnConnectionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateVpnConnection(google::longrunning::Operation const &, Options)

Creates a new VPN connection 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::edgecontainer::v1::VpnConnection > >

DeleteVpnConnection(std::string const &, Options)

Deletes a single VPN connection.

Parameters
Name Description
name std::string const &

Required. The resource name of the vpn connection.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVpnConnection(NoAwaitTag, std::string const &, Options)

Deletes a single VPN connection.

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 >

DeleteVpnConnection(google::cloud::edgecontainer::v1::DeleteVpnConnectionRequest const &, Options)

Deletes a single VPN connection.

Parameters
Name Description
request google::cloud::edgecontainer::v1::DeleteVpnConnectionRequest 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.edgecontainer.v1.DeleteVpnConnectionRequest. 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::edgecontainer::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.edgecontainer.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVpnConnection(NoAwaitTag, google::cloud::edgecontainer::v1::DeleteVpnConnectionRequest const &, Options)

Deletes a single VPN connection.

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::edgecontainer::v1::DeleteVpnConnectionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteVpnConnection(google::longrunning::Operation const &, Options)

Deletes a single VPN connection.

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::edgecontainer::v1::OperationMetadata > >

GetServerConfig(std::string const &, Options)

Gets the server config.

Parameters
Name Description
name std::string const &

Required. The name (project and location) of the server config to get, specified in the format projects/*/locations/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::edgecontainer::v1::ServerConfig >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.ServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetServerConfig(google::cloud::edgecontainer::v1::GetServerConfigRequest const &, Options)

Gets the server config.

Parameters
Name Description
request google::cloud::edgecontainer::v1::GetServerConfigRequest 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.edgecontainer.v1.GetServerConfigRequest. 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::edgecontainer::v1::ServerConfig >

the result of the RPC. The response message type (google.cloud.edgecontainer.v1.ServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. 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::location::Location >

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.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. 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::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 StatusOr contains the error details.

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 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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. 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::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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. 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.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. 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.