Class VmwareEngineClient (2.24.0)

VMwareEngine manages VMware's private clusters in the Cloud.

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

VmwareEngineClient(VmwareEngineClient const &)

Copy and move support

Parameter
Name Description
VmwareEngineClient const &

VmwareEngineClient(VmwareEngineClient &&)

Copy and move support

Parameter
Name Description
VmwareEngineClient &&

VmwareEngineClient(std::shared_ptr< VmwareEngineConnection >, Options)

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

Operators

operator=(VmwareEngineClient const &)

Copy and move support

Parameter
Name Description
VmwareEngineClient const &
Returns
Type Description
VmwareEngineClient &

operator=(VmwareEngineClient &&)

Copy and move support

Parameter
Name Description
VmwareEngineClient &&
Returns
Type Description
VmwareEngineClient &

Functions

ListPrivateClouds(std::string const &, Options)

Lists PrivateCloud resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::PrivateCloud >

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

ListPrivateClouds(google::cloud::vmwareengine::v1::ListPrivateCloudsRequest, Options)

Lists PrivateCloud resources in a given project and location.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListPrivateCloudsRequest

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.vmwareengine.v1.ListPrivateCloudsRequest. 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::vmwareengine::v1::PrivateCloud >

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

GetPrivateCloud(std::string const &, Options)

Retrieves a PrivateCloud resource by its resource name.

Parameters
Name Description
name std::string const &

Required. The resource name of the private cloud to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::PrivateCloud >

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

GetPrivateCloud(google::cloud::vmwareengine::v1::GetPrivateCloudRequest const &, Options)

Retrieves a PrivateCloud resource by its resource name.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetPrivateCloudRequest 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.vmwareengine.v1.GetPrivateCloudRequest. 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::vmwareengine::v1::PrivateCloud >

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

CreatePrivateCloud(std::string const &, google::cloud::vmwareengine::v1::PrivateCloud const &, std::string const &, Options)

Creates a new PrivateCloud resource in a given project and location.

Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

private_cloud google::cloud::vmwareengine::v1::PrivateCloud const &

Required. The initial description of the new private cloud.

private_cloud_id std::string const &

Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each PrivateCloud within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateCloud > >

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

CreatePrivateCloud(google::cloud::vmwareengine::v1::CreatePrivateCloudRequest const &, Options)

Creates a new PrivateCloud resource in a given project and location.

Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreatePrivateCloudRequest 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.vmwareengine.v1.CreatePrivateCloudRequest. 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::vmwareengine::v1::PrivateCloud > >

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

UpdatePrivateCloud(google::cloud::vmwareengine::v1::PrivateCloud const &, google::protobuf::FieldMask const &, Options)

Modifies a PrivateCloud resource.

Only the following fields can be updated: description. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
private_cloud google::cloud::vmwareengine::v1::PrivateCloud const &

Required. Private cloud description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the PrivateCloud resource by the update. The fields specified in updateMask 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::vmwareengine::v1::PrivateCloud > >

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

UpdatePrivateCloud(google::cloud::vmwareengine::v1::UpdatePrivateCloudRequest const &, Options)

Modifies a PrivateCloud resource.

Only the following fields can be updated: description. Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdatePrivateCloudRequest 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.vmwareengine.v1.UpdatePrivateCloudRequest. 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::vmwareengine::v1::PrivateCloud > >

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

DeletePrivateCloud(std::string const &, Options)

Schedules a PrivateCloud resource for deletion.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

Parameters
Name Description
name std::string const &

Required. The resource name of the private cloud to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateCloud > >

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

DeletePrivateCloud(google::cloud::vmwareengine::v1::DeletePrivateCloudRequest const &, Options)

Schedules a PrivateCloud resource for deletion.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

Parameters
Name Description
request google::cloud::vmwareengine::v1::DeletePrivateCloudRequest 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.vmwareengine.v1.DeletePrivateCloudRequest. 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::vmwareengine::v1::PrivateCloud > >

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

UndeletePrivateCloud(std::string const &, Options)

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

Parameters
Name Description
name std::string const &

Required. The resource name of the private cloud scheduled for deletion. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateCloud > >

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

UndeletePrivateCloud(google::cloud::vmwareengine::v1::UndeletePrivateCloudRequest const &, Options)

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud.

A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UndeletePrivateCloudRequest 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.vmwareengine.v1.UndeletePrivateCloudRequest. 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::vmwareengine::v1::PrivateCloud > >

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

ListClusters(std::string const &, Options)

Lists Cluster resources in a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

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

Lists Cluster resources in a given private cloud.

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

Retrieves a Cluster resource by its resource name.

Parameters
Name Description
name std::string const &

Required. The cluster resource name to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

opts Options

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

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

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

Retrieves a Cluster resource by its resource name.

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

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

Creates a new cluster in a given private cloud.

Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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

Required. The initial description of the new cluster.

cluster_id std::string const &

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

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

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

Creates a new cluster in a given private cloud.

Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

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

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

Modifies a Cluster resource.

Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

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

Required. The description of the cluster.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the updateMask 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::vmwareengine::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.vmwareengine.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Modifies a Cluster resource.

Only fields specified in updateMask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

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

DeleteCluster(std::string const &, Options)

Deletes a Cluster resource.

To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

Parameters
Name Description
name std::string const &

Required. The resource name of the cluster to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

opts Options

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

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

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

Deletes a Cluster resource.

To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

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

ListNodes(std::string const &, Options)

Lists nodes in a given cluster.

Parameters
Name Description
parent std::string const &

Required. The resource name of the cluster to be queried for nodes. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::Node >

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

ListNodes(google::cloud::vmwareengine::v1::ListNodesRequest, Options)

Lists nodes in a given cluster.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListNodesRequest

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.vmwareengine.v1.ListNodesRequest. 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::vmwareengine::v1::Node >

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

GetNode(std::string const &, Options)

Gets details of a single node.

Parameters
Name Description
name std::string const &

Required. The resource name of the node to retrieve. For example: projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::Node >

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

GetNode(google::cloud::vmwareengine::v1::GetNodeRequest const &, Options)

Gets details of a single node.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetNodeRequest 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.vmwareengine.v1.GetNodeRequest. 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::vmwareengine::v1::Node >

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

ListExternalAddresses(std::string const &, Options)

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for external IP addresses. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::ExternalAddress >

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

ListExternalAddresses(google::cloud::vmwareengine::v1::ListExternalAddressesRequest, Options)

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListExternalAddressesRequest

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.vmwareengine.v1.ListExternalAddressesRequest. 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::vmwareengine::v1::ExternalAddress >

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

FetchNetworkPolicyExternalAddresses(std::string const &, Options)

Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.

Parameters
Name Description
network_policy std::string const &

Required. The resource name of the network policy to query for assigned external IP addresses. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::ExternalAddress >

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

FetchNetworkPolicyExternalAddresses(google::cloud::vmwareengine::v1::FetchNetworkPolicyExternalAddressesRequest, Options)

Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.

Parameters
Name Description
request google::cloud::vmwareengine::v1::FetchNetworkPolicyExternalAddressesRequest

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.vmwareengine.v1.FetchNetworkPolicyExternalAddressesRequest. 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::vmwareengine::v1::ExternalAddress >

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

GetExternalAddress(std::string const &, Options)

Gets details of a single external IP address.

Parameters
Name Description
name std::string const &

Required. The resource name of the external IP address to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-ip

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::ExternalAddress >

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

GetExternalAddress(google::cloud::vmwareengine::v1::GetExternalAddressRequest const &, Options)

Gets details of a single external IP address.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetExternalAddressRequest 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.vmwareengine.v1.GetExternalAddressRequest. 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::vmwareengine::v1::ExternalAddress >

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

CreateExternalAddress(std::string const &, google::cloud::vmwareengine::v1::ExternalAddress const &, std::string const &, Options)

Creates a new ExternalAddress resource in a given private cloud.

The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to create a new external IP address in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

external_address google::cloud::vmwareengine::v1::ExternalAddress const &

Required. The initial description of a new external IP address.

external_address_id std::string const &

Required. The user-provided identifier of the ExternalAddress to be created. This identifier must be unique among ExternalAddress resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::ExternalAddress > >

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

CreateExternalAddress(google::cloud::vmwareengine::v1::CreateExternalAddressRequest const &, Options)

Creates a new ExternalAddress resource in a given private cloud.

The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateExternalAddressRequest 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.vmwareengine.v1.CreateExternalAddressRequest. 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::vmwareengine::v1::ExternalAddress > >

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

UpdateExternalAddress(google::cloud::vmwareengine::v1::ExternalAddress const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single external IP address.

Only fields specified in update_mask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
external_address google::cloud::vmwareengine::v1::ExternalAddress const &

Required. External IP address description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ExternalAddress 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::vmwareengine::v1::ExternalAddress > >

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

UpdateExternalAddress(google::cloud::vmwareengine::v1::UpdateExternalAddressRequest const &, Options)

Updates the parameters of a single external IP address.

Only fields specified in update_mask are applied.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateExternalAddressRequest 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.vmwareengine.v1.UpdateExternalAddressRequest. 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::vmwareengine::v1::ExternalAddress > >

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

DeleteExternalAddress(std::string const &, Options)

Deletes a single external IP address.

When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

Parameters
Name Description
name std::string const &

Required. The resource name of the external IP address to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-ip

opts Options

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

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

DeleteExternalAddress(google::cloud::vmwareengine::v1::DeleteExternalAddressRequest const &, Options)

Deletes a single external IP address.

When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

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

ListSubnets(std::string const &, Options)

Lists subnets in a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for subnets. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::Subnet >

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

ListSubnets(google::cloud::vmwareengine::v1::ListSubnetsRequest, Options)

Lists subnets in a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListSubnetsRequest

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.vmwareengine.v1.ListSubnetsRequest. 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::vmwareengine::v1::Subnet >

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

GetSubnet(std::string const &, Options)

Gets details of a single subnet.

Parameters
Name Description
name std::string const &

Required. The resource name of the subnet to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::Subnet >

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

GetSubnet(google::cloud::vmwareengine::v1::GetSubnetRequest const &, Options)

Gets details of a single subnet.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetSubnetRequest 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.vmwareengine.v1.GetSubnetRequest. 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::vmwareengine::v1::Subnet >

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

UpdateSubnet(google::cloud::vmwareengine::v1::Subnet const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single subnet.

Only fields specified in update_mask are applied.

Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

Parameters
Name Description
subnet google::cloud::vmwareengine::v1::Subnet const &

Required. Subnet description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Subnet 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::vmwareengine::v1::Subnet > >

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

UpdateSubnet(google::cloud::vmwareengine::v1::UpdateSubnetRequest const &, Options)

Updates the parameters of a single subnet.

Only fields specified in update_mask are applied.

Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateSubnetRequest 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.vmwareengine.v1.UpdateSubnetRequest. 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::vmwareengine::v1::Subnet > >

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

ListExternalAccessRules(std::string const &, Options)

Lists ExternalAccessRule resources in the specified network policy.

Parameters
Name Description
parent std::string const &

Required. The resource name of the network policy to query for external access firewall rules. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::ExternalAccessRule >

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

ListExternalAccessRules(google::cloud::vmwareengine::v1::ListExternalAccessRulesRequest, Options)

Lists ExternalAccessRule resources in the specified network policy.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListExternalAccessRulesRequest

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.vmwareengine.v1.ListExternalAccessRulesRequest. 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::vmwareengine::v1::ExternalAccessRule >

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

GetExternalAccessRule(std::string const &, Options)

Gets details of a single external access rule.

Parameters
Name Description
name std::string const &

Required. The resource name of the external access firewall rule to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::ExternalAccessRule >

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

GetExternalAccessRule(google::cloud::vmwareengine::v1::GetExternalAccessRuleRequest const &, Options)

Gets details of a single external access rule.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetExternalAccessRuleRequest 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.vmwareengine.v1.GetExternalAccessRuleRequest. 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::vmwareengine::v1::ExternalAccessRule >

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

CreateExternalAccessRule(std::string const &, google::cloud::vmwareengine::v1::ExternalAccessRule const &, std::string const &, Options)

Creates a new external access rule in a given network policy.

Parameters
Name Description
parent std::string const &

Required. The resource name of the network policy to create a new external access firewall rule in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy

external_access_rule google::cloud::vmwareengine::v1::ExternalAccessRule const &

Required. The initial description of a new external access rule.

external_access_rule_id std::string const &

Required. The user-provided identifier of the ExternalAccessRule to be created. This identifier must be unique among ExternalAccessRule resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::ExternalAccessRule > >

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

CreateExternalAccessRule(google::cloud::vmwareengine::v1::CreateExternalAccessRuleRequest const &, Options)

Creates a new external access rule in a given network policy.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateExternalAccessRuleRequest 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.vmwareengine.v1.CreateExternalAccessRuleRequest. 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::vmwareengine::v1::ExternalAccessRule > >

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

UpdateExternalAccessRule(google::cloud::vmwareengine::v1::ExternalAccessRule const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single external access rule.

Only fields specified in update_mask are applied.

Parameters
Name Description
external_access_rule google::cloud::vmwareengine::v1::ExternalAccessRule const &

Required. Description of the external access rule.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ExternalAccessRule 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::vmwareengine::v1::ExternalAccessRule > >

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

UpdateExternalAccessRule(google::cloud::vmwareengine::v1::UpdateExternalAccessRuleRequest const &, Options)

Updates the parameters of a single external access rule.

Only fields specified in update_mask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateExternalAccessRuleRequest 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.vmwareengine.v1.UpdateExternalAccessRuleRequest. 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::vmwareengine::v1::ExternalAccessRule > >

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

DeleteExternalAccessRule(std::string const &, Options)

Deletes a single external access rule.

Parameters
Name Description
name std::string const &

Required. The resource name of the external access firewall rule to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule

opts Options

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

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

DeleteExternalAccessRule(google::cloud::vmwareengine::v1::DeleteExternalAccessRuleRequest const &, Options)

Deletes a single external access rule.

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

ListLoggingServers(std::string const &, Options)

Lists logging servers configured for a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for logging servers. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::LoggingServer >

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

ListLoggingServers(google::cloud::vmwareengine::v1::ListLoggingServersRequest, Options)

Lists logging servers configured for a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListLoggingServersRequest

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.vmwareengine.v1.ListLoggingServersRequest. 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::vmwareengine::v1::LoggingServer >

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

GetLoggingServer(std::string const &, Options)

Gets details of a logging server.

Parameters
Name Description
name std::string const &

Required. The resource name of the Logging Server to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::LoggingServer >

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

GetLoggingServer(google::cloud::vmwareengine::v1::GetLoggingServerRequest const &, Options)

Gets details of a logging server.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetLoggingServerRequest 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.vmwareengine.v1.GetLoggingServerRequest. 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::vmwareengine::v1::LoggingServer >

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

CreateLoggingServer(std::string const &, google::cloud::vmwareengine::v1::LoggingServer const &, std::string const &, Options)

Create a new logging server for a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to create a new Logging Server in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

logging_server google::cloud::vmwareengine::v1::LoggingServer const &

Required. The initial description of a new logging server.

logging_server_id std::string const &

Required. The user-provided identifier of the LoggingServer to be created. This identifier must be unique among LoggingServer resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::LoggingServer > >

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

CreateLoggingServer(google::cloud::vmwareengine::v1::CreateLoggingServerRequest const &, Options)

Create a new logging server for a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateLoggingServerRequest 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.vmwareengine.v1.CreateLoggingServerRequest. 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::vmwareengine::v1::LoggingServer > >

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

UpdateLoggingServer(google::cloud::vmwareengine::v1::LoggingServer const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single logging server.

Only fields specified in update_mask are applied.

Parameters
Name Description
logging_server google::cloud::vmwareengine::v1::LoggingServer const &

Required. Logging server description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the LoggingServer 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::vmwareengine::v1::LoggingServer > >

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

UpdateLoggingServer(google::cloud::vmwareengine::v1::UpdateLoggingServerRequest const &, Options)

Updates the parameters of a single logging server.

Only fields specified in update_mask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateLoggingServerRequest 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.vmwareengine.v1.UpdateLoggingServerRequest. 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::vmwareengine::v1::LoggingServer > >

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

DeleteLoggingServer(std::string const &, Options)

Deletes a single logging server.

Parameters
Name Description
name std::string const &

Required. The resource name of the logging server to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server

opts Options

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

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

DeleteLoggingServer(google::cloud::vmwareengine::v1::DeleteLoggingServerRequest const &, Options)

Deletes a single logging server.

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

ListNodeTypes(std::string const &, Options)

Lists node types.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to be queried for node types. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::NodeType >

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

ListNodeTypes(google::cloud::vmwareengine::v1::ListNodeTypesRequest, Options)

Lists node types.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListNodeTypesRequest

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.vmwareengine.v1.ListNodeTypesRequest. 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::vmwareengine::v1::NodeType >

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

GetNodeType(std::string const &, Options)

Gets details of a single NodeType.

Parameters
Name Description
name std::string const &

Required. The resource name of the node type to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-proj/locations/us-central1-a/nodeTypes/standard-72

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::NodeType >

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

GetNodeType(google::cloud::vmwareengine::v1::GetNodeTypeRequest const &, Options)

Gets details of a single NodeType.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetNodeTypeRequest 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.vmwareengine.v1.GetNodeTypeRequest. 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::vmwareengine::v1::NodeType >

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

ShowNsxCredentials(std::string const &, Options)

Gets details of credentials for NSX appliance.

Parameters
Name Description
private_cloud std::string const &

Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::Credentials >

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

ShowNsxCredentials(google::cloud::vmwareengine::v1::ShowNsxCredentialsRequest const &, Options)

Gets details of credentials for NSX appliance.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ShowNsxCredentialsRequest 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.vmwareengine.v1.ShowNsxCredentialsRequest. 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::vmwareengine::v1::Credentials >

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

ShowVcenterCredentials(std::string const &, Options)

Gets details of credentials for Vcenter appliance.

Parameters
Name Description
private_cloud std::string const &

Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::Credentials >

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

ShowVcenterCredentials(google::cloud::vmwareengine::v1::ShowVcenterCredentialsRequest const &, Options)

Gets details of credentials for Vcenter appliance.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ShowVcenterCredentialsRequest 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.vmwareengine.v1.ShowVcenterCredentialsRequest. 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::vmwareengine::v1::Credentials >

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

ResetNsxCredentials(std::string const &, Options)

Resets credentials of the NSX appliance.

Parameters
Name Description
private_cloud std::string const &

Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateCloud > >

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

ResetNsxCredentials(google::cloud::vmwareengine::v1::ResetNsxCredentialsRequest const &, Options)

Resets credentials of the NSX appliance.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ResetNsxCredentialsRequest 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.vmwareengine.v1.ResetNsxCredentialsRequest. 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::vmwareengine::v1::PrivateCloud > >

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

ResetVcenterCredentials(std::string const &, Options)

Resets credentials of the Vcenter appliance.

Parameters
Name Description
private_cloud std::string const &

Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateCloud > >

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

ResetVcenterCredentials(google::cloud::vmwareengine::v1::ResetVcenterCredentialsRequest const &, Options)

Resets credentials of the Vcenter appliance.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ResetVcenterCredentialsRequest 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.vmwareengine.v1.ResetVcenterCredentialsRequest. 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::vmwareengine::v1::PrivateCloud > >

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

GetDnsForwarding(std::string const &, Options)

Gets details of the DnsForwarding config.

Parameters
Name Description
name std::string const &

Required. The resource name of a DnsForwarding to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::DnsForwarding >

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

GetDnsForwarding(google::cloud::vmwareengine::v1::GetDnsForwardingRequest const &, Options)

Gets details of the DnsForwarding config.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetDnsForwardingRequest 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.vmwareengine.v1.GetDnsForwardingRequest. 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::vmwareengine::v1::DnsForwarding >

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

UpdateDnsForwarding(google::cloud::vmwareengine::v1::DnsForwarding const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the DnsForwarding config, like associated domains.

Only fields specified in update_mask are applied.

Parameters
Name Description
dns_forwarding google::cloud::vmwareengine::v1::DnsForwarding const &

Required. DnsForwarding config details.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the DnsForwarding 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::vmwareengine::v1::DnsForwarding > >

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

UpdateDnsForwarding(google::cloud::vmwareengine::v1::UpdateDnsForwardingRequest const &, Options)

Updates the parameters of the DnsForwarding config, like associated domains.

Only fields specified in update_mask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateDnsForwardingRequest 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.vmwareengine.v1.UpdateDnsForwardingRequest. 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::vmwareengine::v1::DnsForwarding > >

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

GetNetworkPeering(std::string const &, Options)

Retrieves a NetworkPeering resource by its resource name.

The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
name std::string const &

Required. The resource name of the network peering to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::NetworkPeering >

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

GetNetworkPeering(google::cloud::vmwareengine::v1::GetNetworkPeeringRequest const &, Options)

Retrieves a NetworkPeering resource by its resource name.

The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetNetworkPeeringRequest 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.vmwareengine.v1.GetNetworkPeeringRequest. 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::vmwareengine::v1::NetworkPeering >

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

ListNetworkPeerings(std::string const &, Options)

Lists NetworkPeering resources in a given project.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location (global) to query for network peerings. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::NetworkPeering >

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

ListNetworkPeerings(google::cloud::vmwareengine::v1::ListNetworkPeeringsRequest, Options)

Lists NetworkPeering resources in a given project.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListNetworkPeeringsRequest

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.vmwareengine.v1.ListNetworkPeeringsRequest. 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::vmwareengine::v1::NetworkPeering >

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

CreateNetworkPeering(std::string const &, google::cloud::vmwareengine::v1::NetworkPeering const &, std::string const &, Options)

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to create the new network peering in. This value is always global, because NetworkPeering is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

network_peering google::cloud::vmwareengine::v1::NetworkPeering const &

Required. The initial description of the new network peering.

network_peering_id std::string const &

Required. The user-provided identifier of the new NetworkPeering. This identifier must be unique among NetworkPeering resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::NetworkPeering > >

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

CreateNetworkPeering(google::cloud::vmwareengine::v1::CreateNetworkPeeringRequest const &, Options)

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateNetworkPeeringRequest 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.vmwareengine.v1.CreateNetworkPeeringRequest. 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::vmwareengine::v1::NetworkPeering > >

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

DeleteNetworkPeering(std::string const &, Options)

Deletes a NetworkPeering resource.

When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
name std::string const &

Required. The resource name of the network peering to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

opts Options

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

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

DeleteNetworkPeering(google::cloud::vmwareengine::v1::DeleteNetworkPeeringRequest const &, Options)

Deletes a NetworkPeering resource.

When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

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

UpdateNetworkPeering(google::cloud::vmwareengine::v1::NetworkPeering const &, google::protobuf::FieldMask const &, Options)

Modifies a NetworkPeering resource.

Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
network_peering google::cloud::vmwareengine::v1::NetworkPeering const &

Required. Network peering description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the NetworkPeering 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::vmwareengine::v1::NetworkPeering > >

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

UpdateNetworkPeering(google::cloud::vmwareengine::v1::UpdateNetworkPeeringRequest const &, Options)

Modifies a NetworkPeering resource.

Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateNetworkPeeringRequest 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.vmwareengine.v1.UpdateNetworkPeeringRequest. 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::vmwareengine::v1::NetworkPeering > >

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

ListPeeringRoutes(std::string const &, Options)

Lists the network peering routes exchanged over a peering connection.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
parent std::string const &

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::PeeringRoute >

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

ListPeeringRoutes(google::cloud::vmwareengine::v1::ListPeeringRoutesRequest, Options)

Lists the network peering routes exchanged over a peering connection.

NetworkPeering is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListPeeringRoutesRequest

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.vmwareengine.v1.ListPeeringRoutesRequest. 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::vmwareengine::v1::PeeringRoute >

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

CreateHcxActivationKey(std::string const &, google::cloud::vmwareengine::v1::HcxActivationKey const &, std::string const &, Options)

Creates a new HCX activation key in a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcx_activation_key google::cloud::vmwareengine::v1::HcxActivationKey const &

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcx_activation_key_id std::string const &

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::HcxActivationKey > >

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

CreateHcxActivationKey(google::cloud::vmwareengine::v1::CreateHcxActivationKeyRequest const &, Options)

Creates a new HCX activation key in a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateHcxActivationKeyRequest 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.vmwareengine.v1.CreateHcxActivationKeyRequest. 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::vmwareengine::v1::HcxActivationKey > >

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

ListHcxActivationKeys(std::string const &, Options)

Lists HcxActivationKey resources in a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for HCX activation keys. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::HcxActivationKey >

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

ListHcxActivationKeys(google::cloud::vmwareengine::v1::ListHcxActivationKeysRequest, Options)

Lists HcxActivationKey resources in a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListHcxActivationKeysRequest

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.vmwareengine.v1.ListHcxActivationKeysRequest. 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::vmwareengine::v1::HcxActivationKey >

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

GetHcxActivationKey(std::string const &, Options)

Retrieves a HcxActivationKey resource by its resource name.

Parameters
Name Description
name std::string const &

Required. The resource name of the HCX activation key to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::HcxActivationKey >

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

GetHcxActivationKey(google::cloud::vmwareengine::v1::GetHcxActivationKeyRequest const &, Options)

Retrieves a HcxActivationKey resource by its resource name.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetHcxActivationKeyRequest 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.vmwareengine.v1.GetHcxActivationKeyRequest. 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::vmwareengine::v1::HcxActivationKey >

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

GetNetworkPolicy(std::string const &, Options)

Retrieves a NetworkPolicy resource by its resource name.

Parameters
Name Description
name std::string const &

Required. The resource name of the network policy to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-network-policy

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::NetworkPolicy >

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

GetNetworkPolicy(google::cloud::vmwareengine::v1::GetNetworkPolicyRequest const &, Options)

Retrieves a NetworkPolicy resource by its resource name.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetNetworkPolicyRequest 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.vmwareengine.v1.GetNetworkPolicyRequest. 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::vmwareengine::v1::NetworkPolicy >

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

ListNetworkPolicies(std::string const &, Options)

Lists NetworkPolicy resources in a specified project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location (region) to query for network policies. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::NetworkPolicy >

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

ListNetworkPolicies(google::cloud::vmwareengine::v1::ListNetworkPoliciesRequest, Options)

Lists NetworkPolicy resources in a specified project and location.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListNetworkPoliciesRequest

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.vmwareengine.v1.ListNetworkPoliciesRequest. 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::vmwareengine::v1::NetworkPolicy >

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

CreateNetworkPolicy(std::string const &, google::cloud::vmwareengine::v1::NetworkPolicy const &, std::string const &, Options)

Creates a new network policy in a given VMware Engine network of a project and location (region).

A new network policy cannot be created if another network policy already exists in the same scope.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

network_policy google::cloud::vmwareengine::v1::NetworkPolicy const &

Required. The network policy configuration to use in the request.

network_policy_id std::string const &

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::NetworkPolicy > >

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

CreateNetworkPolicy(google::cloud::vmwareengine::v1::CreateNetworkPolicyRequest const &, Options)

Creates a new network policy in a given VMware Engine network of a project and location (region).

A new network policy cannot be created if another network policy already exists in the same scope.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateNetworkPolicyRequest 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.vmwareengine.v1.CreateNetworkPolicyRequest. 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::vmwareengine::v1::NetworkPolicy > >

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

UpdateNetworkPolicy(google::cloud::vmwareengine::v1::NetworkPolicy const &, google::protobuf::FieldMask const &, Options)

Modifies a NetworkPolicy resource.

Only the following fields can be updated: internet_access, external_ip, edge_services_cidr. Only fields specified in updateMask are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService cannot be updated when NetworkService.state is set to RECONCILING.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
network_policy google::cloud::vmwareengine::v1::NetworkPolicy const &

Required. Network policy description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the NetworkPolicy 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::vmwareengine::v1::NetworkPolicy > >

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

UpdateNetworkPolicy(google::cloud::vmwareengine::v1::UpdateNetworkPolicyRequest const &, Options)

Modifies a NetworkPolicy resource.

Only the following fields can be updated: internet_access, external_ip, edge_services_cidr. Only fields specified in updateMask are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService cannot be updated when NetworkService.state is set to RECONCILING.

During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateNetworkPolicyRequest 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.vmwareengine.v1.UpdateNetworkPolicyRequest. 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::vmwareengine::v1::NetworkPolicy > >

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

DeleteNetworkPolicy(std::string const &, Options)

Deletes a NetworkPolicy resource.

A network policy cannot be deleted when NetworkService.state is set to RECONCILING for either its external IP or internet access service.

Parameters
Name Description
name std::string const &

Required. The resource name of the network policy to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-network-policy

opts Options

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

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

DeleteNetworkPolicy(google::cloud::vmwareengine::v1::DeleteNetworkPolicyRequest const &, Options)

Deletes a NetworkPolicy resource.

A network policy cannot be deleted when NetworkService.state is set to RECONCILING for either its external IP or internet access service.

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

ListManagementDnsZoneBindings(std::string const &, Options)

Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to be queried for management DNS zone bindings. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::ManagementDnsZoneBinding >

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

ListManagementDnsZoneBindings(google::cloud::vmwareengine::v1::ListManagementDnsZoneBindingsRequest, Options)

Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListManagementDnsZoneBindingsRequest

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.vmwareengine.v1.ListManagementDnsZoneBindingsRequest. 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::vmwareengine::v1::ManagementDnsZoneBinding >

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

GetManagementDnsZoneBinding(std::string const &, Options)

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Parameters
Name Description
name std::string const &

Required. The resource name of the management DNS zone binding to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::ManagementDnsZoneBinding >

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

GetManagementDnsZoneBinding(google::cloud::vmwareengine::v1::GetManagementDnsZoneBindingRequest const &, Options)

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetManagementDnsZoneBindingRequest 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.vmwareengine.v1.GetManagementDnsZoneBindingRequest. 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::vmwareengine::v1::ManagementDnsZoneBinding >

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

CreateManagementDnsZoneBinding(std::string const &, google::cloud::vmwareengine::v1::ManagementDnsZoneBinding const &, std::string const &, Options)

Creates a new ManagementDnsZoneBinding resource in a private cloud.

This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private cloud to create a new management DNS zone binding for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

management_dns_zone_binding google::cloud::vmwareengine::v1::ManagementDnsZoneBinding const &

Required. The initial values for a new management DNS zone binding.

management_dns_zone_binding_id std::string const &

Required. The user-provided identifier of the ManagementDnsZoneBinding resource to be created. This identifier must be unique among ManagementDnsZoneBinding resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::ManagementDnsZoneBinding > >

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

CreateManagementDnsZoneBinding(google::cloud::vmwareengine::v1::CreateManagementDnsZoneBindingRequest const &, Options)

Creates a new ManagementDnsZoneBinding resource in a private cloud.

This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateManagementDnsZoneBindingRequest 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.vmwareengine.v1.CreateManagementDnsZoneBindingRequest. 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::vmwareengine::v1::ManagementDnsZoneBinding > >

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

UpdateManagementDnsZoneBinding(google::cloud::vmwareengine::v1::ManagementDnsZoneBinding const &, google::protobuf::FieldMask const &, Options)

Updates a ManagementDnsZoneBinding resource.

Only fields specified in update_mask are applied.

Parameters
Name Description
management_dns_zone_binding google::cloud::vmwareengine::v1::ManagementDnsZoneBinding const &

Required. New values to update the management DNS zone binding with.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ManagementDnsZoneBinding 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::vmwareengine::v1::ManagementDnsZoneBinding > >

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

UpdateManagementDnsZoneBinding(google::cloud::vmwareengine::v1::UpdateManagementDnsZoneBindingRequest const &, Options)

Updates a ManagementDnsZoneBinding resource.

Only fields specified in update_mask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateManagementDnsZoneBindingRequest 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.vmwareengine.v1.UpdateManagementDnsZoneBindingRequest. 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::vmwareengine::v1::ManagementDnsZoneBinding > >

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

DeleteManagementDnsZoneBinding(std::string const &, Options)

Deletes a ManagementDnsZoneBinding resource.

When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone.

Parameters
Name Description
name std::string const &

Required. The resource name of the management DNS zone binding to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding

opts Options

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

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

DeleteManagementDnsZoneBinding(google::cloud::vmwareengine::v1::DeleteManagementDnsZoneBindingRequest const &, Options)

Deletes a ManagementDnsZoneBinding resource.

When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone.

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

RepairManagementDnsZoneBinding(std::string const &, Options)

Retries to create a ManagementDnsZoneBinding resource that is in failed state.

Parameters
Name Description
name std::string const &

Required. The resource name of the management DNS zone binding to repair. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::ManagementDnsZoneBinding > >

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

RepairManagementDnsZoneBinding(google::cloud::vmwareengine::v1::RepairManagementDnsZoneBindingRequest const &, Options)

Retries to create a ManagementDnsZoneBinding resource that is in failed state.

Parameters
Name Description
request google::cloud::vmwareengine::v1::RepairManagementDnsZoneBindingRequest 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.vmwareengine.v1.RepairManagementDnsZoneBindingRequest. 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::vmwareengine::v1::ManagementDnsZoneBinding > >

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

CreateVmwareEngineNetwork(std::string const &, google::cloud::vmwareengine::v1::VmwareEngineNetwork const &, std::string const &, Options)

Creates a new VMware Engine network that can be used by a private cloud.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type LEGACY is a regional resource, and a VMware Engine network of type STANDARD is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

vmware_engine_network google::cloud::vmwareengine::v1::VmwareEngineNetwork const &

Required. The initial description of the new VMware Engine network.

vmware_engine_network_id std::string const &

Required. The user-provided identifier of the new VMware Engine network. This identifier must be unique among VMware Engine network resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • For networks of type LEGACY, adheres to the format: {region-id}-default. Replace {region-id} with the region where you want to create the VMware Engine network. For example, "us-central1-default".
  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::VmwareEngineNetwork > >

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

CreateVmwareEngineNetwork(google::cloud::vmwareengine::v1::CreateVmwareEngineNetworkRequest const &, Options)

Creates a new VMware Engine network that can be used by a private cloud.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreateVmwareEngineNetworkRequest 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.vmwareengine.v1.CreateVmwareEngineNetworkRequest. 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::vmwareengine::v1::VmwareEngineNetwork > >

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

UpdateVmwareEngineNetwork(google::cloud::vmwareengine::v1::VmwareEngineNetwork const &, google::protobuf::FieldMask const &, Options)

Modifies a VMware Engine network resource.

Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Parameters
Name Description
vmware_engine_network google::cloud::vmwareengine::v1::VmwareEngineNetwork const &

Required. VMware Engine network description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the VMware Engine network 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. Only the following fields can be updated: description.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::VmwareEngineNetwork > >

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

UpdateVmwareEngineNetwork(google::cloud::vmwareengine::v1::UpdateVmwareEngineNetworkRequest const &, Options)

Modifies a VMware Engine network resource.

Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdateVmwareEngineNetworkRequest 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.vmwareengine.v1.UpdateVmwareEngineNetworkRequest. 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::vmwareengine::v1::VmwareEngineNetwork > >

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

DeleteVmwareEngineNetwork(std::string const &, Options)

Deletes a VmwareEngineNetwork resource.

You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

Parameters
Name Description
name std::string const &

Required. The resource name of the VMware Engine network to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network

opts Options

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

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

DeleteVmwareEngineNetwork(google::cloud::vmwareengine::v1::DeleteVmwareEngineNetworkRequest const &, Options)

Deletes a VmwareEngineNetwork resource.

You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

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

GetVmwareEngineNetwork(std::string const &, Options)

Retrieves a VmwareEngineNetwork resource by its resource name.

The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

Parameters
Name Description
name std::string const &

Required. The resource name of the VMware Engine network to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::VmwareEngineNetwork >

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

GetVmwareEngineNetwork(google::cloud::vmwareengine::v1::GetVmwareEngineNetworkRequest const &, Options)

Retrieves a VmwareEngineNetwork resource by its resource name.

The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetVmwareEngineNetworkRequest 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.vmwareengine.v1.GetVmwareEngineNetworkRequest. 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::vmwareengine::v1::VmwareEngineNetwork >

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

ListVmwareEngineNetworks(std::string const &, Options)

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::VmwareEngineNetwork >

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

ListVmwareEngineNetworks(google::cloud::vmwareengine::v1::ListVmwareEngineNetworksRequest, Options)

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListVmwareEngineNetworksRequest

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.vmwareengine.v1.ListVmwareEngineNetworksRequest. 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::vmwareengine::v1::VmwareEngineNetwork >

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

CreatePrivateConnection(std::string const &, google::cloud::vmwareengine::v1::PrivateConnection const &, std::string const &, Options)

Creates a new private connection that can be used for accessing private Clouds.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to create the new private connection in. Private connection is a regional resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

private_connection google::cloud::vmwareengine::v1::PrivateConnection const &

Required. The initial description of the new private connection.

private_connection_id std::string const &

Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::PrivateConnection > >

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

CreatePrivateConnection(google::cloud::vmwareengine::v1::CreatePrivateConnectionRequest const &, Options)

Creates a new private connection that can be used for accessing private Clouds.

Parameters
Name Description
request google::cloud::vmwareengine::v1::CreatePrivateConnectionRequest 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.vmwareengine.v1.CreatePrivateConnectionRequest. 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::vmwareengine::v1::PrivateConnection > >

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

GetPrivateConnection(std::string const &, Options)

Retrieves a PrivateConnection resource by its resource name.

The resource contains details of the private connection, such as connected network, routing mode and state.

Parameters
Name Description
name std::string const &

Required. The resource name of the private connection to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::PrivateConnection >

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

GetPrivateConnection(google::cloud::vmwareengine::v1::GetPrivateConnectionRequest const &, Options)

Retrieves a PrivateConnection resource by its resource name.

The resource contains details of the private connection, such as connected network, routing mode and state.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetPrivateConnectionRequest 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.vmwareengine.v1.GetPrivateConnectionRequest. 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::vmwareengine::v1::PrivateConnection >

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

ListPrivateConnections(std::string const &, Options)

Lists PrivateConnection resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the location to query for private connections. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::PrivateConnection >

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

ListPrivateConnections(google::cloud::vmwareengine::v1::ListPrivateConnectionsRequest, Options)

Lists PrivateConnection resources in a given project and location.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListPrivateConnectionsRequest

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.vmwareengine.v1.ListPrivateConnectionsRequest. 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::vmwareengine::v1::PrivateConnection >

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

UpdatePrivateConnection(google::cloud::vmwareengine::v1::PrivateConnection const &, google::protobuf::FieldMask const &, Options)

Modifies a PrivateConnection resource.

Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Parameters
Name Description
private_connection google::cloud::vmwareengine::v1::PrivateConnection const &

Required. Private connection description.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the PrivateConnection 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::vmwareengine::v1::PrivateConnection > >

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

UpdatePrivateConnection(google::cloud::vmwareengine::v1::UpdatePrivateConnectionRequest const &, Options)

Modifies a PrivateConnection resource.

Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Parameters
Name Description
request google::cloud::vmwareengine::v1::UpdatePrivateConnectionRequest 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.vmwareengine.v1.UpdatePrivateConnectionRequest. 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::vmwareengine::v1::PrivateConnection > >

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

DeletePrivateConnection(std::string const &, Options)

Deletes a PrivateConnection resource.

When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.

Parameters
Name Description
name std::string const &

Required. The resource name of the private connection to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection

opts Options

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

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

DeletePrivateConnection(google::cloud::vmwareengine::v1::DeletePrivateConnectionRequest const &, Options)

Deletes a PrivateConnection resource.

When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.

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

ListPrivateConnectionPeeringRoutes(std::string const &, Options)

Lists the private connection routes exchanged over a peering connection.

Parameters
Name Description
parent std::string const &

Required. The resource name of the private connection to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1/privateConnections/my-connection

opts Options

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

Returns
Type Description
StreamRange< google::cloud::vmwareengine::v1::PeeringRoute >

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

ListPrivateConnectionPeeringRoutes(google::cloud::vmwareengine::v1::ListPrivateConnectionPeeringRoutesRequest, Options)

Lists the private connection routes exchanged over a peering connection.

Parameters
Name Description
request google::cloud::vmwareengine::v1::ListPrivateConnectionPeeringRoutesRequest

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.vmwareengine.v1.ListPrivateConnectionPeeringRoutesRequest. 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::vmwareengine::v1::PeeringRoute >

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

GrantDnsBindPermission(std::string const &, google::cloud::vmwareengine::v1::Principal const &, Options)

Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
name std::string const &

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

principal google::cloud::vmwareengine::v1::Principal const &

Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::DnsBindPermission > >

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

GrantDnsBindPermission(google::cloud::vmwareengine::v1::GrantDnsBindPermissionRequest const &, Options)

Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GrantDnsBindPermissionRequest 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.vmwareengine.v1.GrantDnsBindPermissionRequest. 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::vmwareengine::v1::DnsBindPermission > >

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

GetDnsBindPermission(std::string const &, Options)

Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
name std::string const &

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

opts Options

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

Returns
Type Description
StatusOr< google::cloud::vmwareengine::v1::DnsBindPermission >

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

GetDnsBindPermission(google::cloud::vmwareengine::v1::GetDnsBindPermissionRequest const &, Options)

Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::GetDnsBindPermissionRequest 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.vmwareengine.v1.GetDnsBindPermissionRequest. 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::vmwareengine::v1::DnsBindPermission >

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

RevokeDnsBindPermission(std::string const &, google::cloud::vmwareengine::v1::Principal const &, Options)

Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
name std::string const &

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

principal google::cloud::vmwareengine::v1::Principal const &

Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::vmwareengine::v1::DnsBindPermission > >

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

RevokeDnsBindPermission(google::cloud::vmwareengine::v1::RevokeDnsBindPermissionRequest const &, Options)

Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project.

DnsBindPermission is a global resource and location can only be global.

Parameters
Name Description
request google::cloud::vmwareengine::v1::RevokeDnsBindPermissionRequest 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.vmwareengine.v1.RevokeDnsBindPermissionRequest. 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::vmwareengine::v1::DnsBindPermission > >

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