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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 can only be created in zones, regional private clouds are not supported.
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: |
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
|
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 |
CreatePrivateCloud(google::cloud::vmwareengine::v1::CreatePrivateCloudRequest const &, Options)
Creates a new PrivateCloud
resource in a given project and location.
Private clouds can only be created in zones, regional private clouds are not supported.
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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
|
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 |
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 |
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 |
UpdateCluster(google::cloud::vmwareengine::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Modifies a Cluster
resource.
Only the following fields can be updated: node_type_configs.*.node_count
. 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 |
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 |
UpdateCluster(google::cloud::vmwareengine::v1::UpdateClusterRequest const &, Options)
Modifies a Cluster
resource.
Only the following fields can be updated: node_type_configs.*.node_count
. 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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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
|
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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:
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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:
|
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |