Class VmwareEngineClient (0.45.0)

GitHub RepositoryProduct ReferenceREST Documentation

Service Description: VMwareEngine manages VMware's private clusters in the Cloud.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.getPrivateCloud(name);
 }
 

Note: close() needs to be called on the VmwareEngineClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListPrivateClouds

Lists PrivateCloud resources in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPrivateClouds(ListPrivateCloudsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrivateClouds(LocationName parent)

  • listPrivateClouds(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPrivateCloudsPagedCallable()

  • listPrivateCloudsCallable()

GetPrivateCloud

Retrieves a PrivateCloud resource by its resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPrivateCloud(GetPrivateCloudRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPrivateCloud(PrivateCloudName name)

  • getPrivateCloud(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPrivateCloudCallable()

CreatePrivateCloud

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPrivateCloudAsync(CreatePrivateCloudRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createPrivateCloudAsync(LocationName parent, PrivateCloud privateCloud, String privateCloudId)

  • createPrivateCloudAsync(String parent, PrivateCloud privateCloud, String privateCloudId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPrivateCloudOperationCallable()

  • createPrivateCloudCallable()

UpdatePrivateCloud

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePrivateCloudAsync(UpdatePrivateCloudRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updatePrivateCloudAsync(PrivateCloud privateCloud, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePrivateCloudOperationCallable()

  • updatePrivateCloudCallable()

DeletePrivateCloud

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePrivateCloudAsync(DeletePrivateCloudRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deletePrivateCloudAsync(PrivateCloudName name)

  • deletePrivateCloudAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePrivateCloudOperationCallable()

  • deletePrivateCloudCallable()

UndeletePrivateCloud

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeletePrivateCloudAsync(UndeletePrivateCloudRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • undeletePrivateCloudAsync(PrivateCloudName name)

  • undeletePrivateCloudAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeletePrivateCloudOperationCallable()

  • undeletePrivateCloudCallable()

ListClusters

Lists Cluster resources in a given private cloud.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listClusters(ListClustersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listClusters(PrivateCloudName parent)

  • listClusters(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listClustersPagedCallable()

  • listClustersCallable()

GetCluster

Retrieves a Cluster resource by its resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCluster(GetClusterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCluster(ClusterName name)

  • getCluster(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getClusterCallable()

CreateCluster

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createClusterAsync(CreateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createClusterAsync(PrivateCloudName parent, Cluster cluster, String clusterId)

  • createClusterAsync(String parent, Cluster cluster, String clusterId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createClusterOperationCallable()

  • createClusterCallable()

UpdateCluster

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateClusterAsync(UpdateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateClusterAsync(Cluster cluster, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateClusterOperationCallable()

  • updateClusterCallable()

DeleteCluster

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteClusterAsync(DeleteClusterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteClusterAsync(ClusterName name)

  • deleteClusterAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteClusterOperationCallable()

  • deleteClusterCallable()

ListNodes

Lists nodes in a given cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNodes(ListNodesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNodes(ClusterName parent)

  • listNodes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNodesPagedCallable()

  • listNodesCallable()

GetNode

Gets details of a single node.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNode(GetNodeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNode(NodeName name)

  • getNode(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNodeCallable()

ListExternalAddresses

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listExternalAddresses(ListExternalAddressesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listExternalAddresses(PrivateCloudName parent)

  • listExternalAddresses(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listExternalAddressesPagedCallable()

  • listExternalAddressesCallable()

FetchNetworkPolicyExternalAddresses

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • fetchNetworkPolicyExternalAddresses(FetchNetworkPolicyExternalAddressesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • fetchNetworkPolicyExternalAddresses(NetworkPolicyName networkPolicy)

  • fetchNetworkPolicyExternalAddresses(String networkPolicy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • fetchNetworkPolicyExternalAddressesPagedCallable()

  • fetchNetworkPolicyExternalAddressesCallable()

GetExternalAddress

Gets details of a single external IP address.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getExternalAddress(GetExternalAddressRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getExternalAddress(ExternalAddressName name)

  • getExternalAddress(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getExternalAddressCallable()

CreateExternalAddress

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).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createExternalAddressAsync(CreateExternalAddressRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createExternalAddressAsync(PrivateCloudName parent, ExternalAddress externalAddress, String externalAddressId)

  • createExternalAddressAsync(String parent, ExternalAddress externalAddress, String externalAddressId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createExternalAddressOperationCallable()

  • createExternalAddressCallable()

UpdateExternalAddress

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateExternalAddressAsync(UpdateExternalAddressRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateExternalAddressAsync(ExternalAddress externalAddress, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateExternalAddressOperationCallable()

  • updateExternalAddressCallable()

DeleteExternalAddress

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteExternalAddressAsync(DeleteExternalAddressRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteExternalAddressAsync(ExternalAddressName name)

  • deleteExternalAddressAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteExternalAddressOperationCallable()

  • deleteExternalAddressCallable()

ListSubnets

Lists subnets in a given private cloud.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSubnets(ListSubnetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSubnets(PrivateCloudName parent)

  • listSubnets(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSubnetsPagedCallable()

  • listSubnetsCallable()

GetSubnet

Gets details of a single subnet.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSubnet(GetSubnetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSubnet(SubnetName name)

  • getSubnet(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSubnetCallable()

UpdateSubnet

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSubnetAsync(UpdateSubnetRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateSubnetAsync(Subnet subnet, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSubnetOperationCallable()

  • updateSubnetCallable()

ListExternalAccessRules

Lists ExternalAccessRule resources in the specified network policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listExternalAccessRules(ListExternalAccessRulesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listExternalAccessRules(NetworkPolicyName parent)

  • listExternalAccessRules(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listExternalAccessRulesPagedCallable()

  • listExternalAccessRulesCallable()

GetExternalAccessRule

Gets details of a single external access rule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getExternalAccessRule(GetExternalAccessRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getExternalAccessRule(ExternalAccessRuleName name)

  • getExternalAccessRule(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getExternalAccessRuleCallable()

CreateExternalAccessRule

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createExternalAccessRuleAsync(CreateExternalAccessRuleRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createExternalAccessRuleAsync(NetworkPolicyName parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

  • createExternalAccessRuleAsync(String parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createExternalAccessRuleOperationCallable()

  • createExternalAccessRuleCallable()

UpdateExternalAccessRule

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateExternalAccessRuleAsync(UpdateExternalAccessRuleRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateExternalAccessRuleAsync(ExternalAccessRule externalAccessRule, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateExternalAccessRuleOperationCallable()

  • updateExternalAccessRuleCallable()

DeleteExternalAccessRule

Deletes a single external access rule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteExternalAccessRuleAsync(DeleteExternalAccessRuleRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteExternalAccessRuleAsync(ExternalAccessRuleName name)

  • deleteExternalAccessRuleAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteExternalAccessRuleOperationCallable()

  • deleteExternalAccessRuleCallable()

ListLoggingServers

Lists logging servers configured for a given private cloud.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLoggingServers(ListLoggingServersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLoggingServers(PrivateCloudName parent)

  • listLoggingServers(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLoggingServersPagedCallable()

  • listLoggingServersCallable()

GetLoggingServer

Gets details of a logging server.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLoggingServer(GetLoggingServerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getLoggingServer(LoggingServerName name)

  • getLoggingServer(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLoggingServerCallable()

CreateLoggingServer

Create a new logging server for a given private cloud.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createLoggingServerAsync(CreateLoggingServerRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createLoggingServerAsync(PrivateCloudName parent, LoggingServer loggingServer, String loggingServerId)

  • createLoggingServerAsync(String parent, LoggingServer loggingServer, String loggingServerId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createLoggingServerOperationCallable()

  • createLoggingServerCallable()

UpdateLoggingServer

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateLoggingServerAsync(UpdateLoggingServerRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateLoggingServerAsync(LoggingServer loggingServer, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateLoggingServerOperationCallable()

  • updateLoggingServerCallable()

DeleteLoggingServer

Deletes a single logging server.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteLoggingServerAsync(DeleteLoggingServerRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteLoggingServerAsync(LoggingServerName name)

  • deleteLoggingServerAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteLoggingServerOperationCallable()

  • deleteLoggingServerCallable()

ListNodeTypes

Lists node types

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNodeTypes(ListNodeTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNodeTypes(LocationName parent)

  • listNodeTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNodeTypesPagedCallable()

  • listNodeTypesCallable()

GetNodeType

Gets details of a single NodeType.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNodeType(GetNodeTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNodeType(NodeTypeName name)

  • getNodeType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNodeTypeCallable()

ShowNsxCredentials

Gets details of credentials for NSX appliance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • showNsxCredentials(ShowNsxCredentialsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • showNsxCredentials(PrivateCloudName privateCloud)

  • showNsxCredentials(String privateCloud)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • showNsxCredentialsCallable()

ShowVcenterCredentials

Gets details of credentials for Vcenter appliance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • showVcenterCredentials(ShowVcenterCredentialsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • showVcenterCredentials(PrivateCloudName privateCloud)

  • showVcenterCredentials(String privateCloud)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • showVcenterCredentialsCallable()

ResetNsxCredentials

Resets credentials of the NSX appliance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetNsxCredentialsAsync(ResetNsxCredentialsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • resetNsxCredentialsAsync(PrivateCloudName privateCloud)

  • resetNsxCredentialsAsync(String privateCloud)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetNsxCredentialsOperationCallable()

  • resetNsxCredentialsCallable()

ResetVcenterCredentials

Resets credentials of the Vcenter appliance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetVcenterCredentialsAsync(ResetVcenterCredentialsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • resetVcenterCredentialsAsync(PrivateCloudName privateCloud)

  • resetVcenterCredentialsAsync(String privateCloud)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetVcenterCredentialsOperationCallable()

  • resetVcenterCredentialsCallable()

GetDnsForwarding

Gets details of the DnsForwarding config.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDnsForwarding(GetDnsForwardingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDnsForwarding(DnsForwardingName name)

  • getDnsForwarding(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDnsForwardingCallable()

UpdateDnsForwarding

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDnsForwardingAsync(UpdateDnsForwardingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateDnsForwardingAsync(DnsForwarding dnsForwarding, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDnsForwardingOperationCallable()

  • updateDnsForwardingCallable()

GetNetworkPeering

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNetworkPeering(GetNetworkPeeringRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNetworkPeering(NetworkPeeringName name)

  • getNetworkPeering(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNetworkPeeringCallable()

ListNetworkPeerings

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNetworkPeerings(ListNetworkPeeringsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNetworkPeerings(LocationName parent)

  • listNetworkPeerings(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNetworkPeeringsPagedCallable()

  • listNetworkPeeringsCallable()

CreateNetworkPeering

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createNetworkPeeringAsync(CreateNetworkPeeringRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createNetworkPeeringAsync(LocationName parent, NetworkPeering networkPeering, String networkPeeringId)

  • createNetworkPeeringAsync(String parent, NetworkPeering networkPeering, String networkPeeringId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createNetworkPeeringOperationCallable()

  • createNetworkPeeringCallable()

DeleteNetworkPeering

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteNetworkPeeringAsync(DeleteNetworkPeeringRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteNetworkPeeringAsync(NetworkPeeringName name)

  • deleteNetworkPeeringAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteNetworkPeeringOperationCallable()

  • deleteNetworkPeeringCallable()

UpdateNetworkPeering

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateNetworkPeeringAsync(UpdateNetworkPeeringRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateNetworkPeeringAsync(NetworkPeering networkPeering, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateNetworkPeeringOperationCallable()

  • updateNetworkPeeringCallable()

ListPeeringRoutes

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPeeringRoutes(ListPeeringRoutesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPeeringRoutes(NetworkPeeringName parent)

  • listPeeringRoutes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPeeringRoutesPagedCallable()

  • listPeeringRoutesCallable()

CreateHcxActivationKey

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createHcxActivationKeyAsync(CreateHcxActivationKeyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createHcxActivationKeyAsync(PrivateCloudName parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

  • createHcxActivationKeyAsync(String parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createHcxActivationKeyOperationCallable()

  • createHcxActivationKeyCallable()

ListHcxActivationKeys

Lists HcxActivationKey resources in a given private cloud.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listHcxActivationKeys(ListHcxActivationKeysRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listHcxActivationKeys(PrivateCloudName parent)

  • listHcxActivationKeys(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listHcxActivationKeysPagedCallable()

  • listHcxActivationKeysCallable()

GetHcxActivationKey

Retrieves a HcxActivationKey resource by its resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getHcxActivationKey(GetHcxActivationKeyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getHcxActivationKey(HcxActivationKeyName name)

  • getHcxActivationKey(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getHcxActivationKeyCallable()

GetNetworkPolicy

Retrieves a NetworkPolicy resource by its resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNetworkPolicy(GetNetworkPolicyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNetworkPolicy(NetworkPolicyName name)

  • getNetworkPolicy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNetworkPolicyCallable()

ListNetworkPolicies

Lists NetworkPolicy resources in a specified project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNetworkPolicies(ListNetworkPoliciesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNetworkPolicies(LocationName parent)

  • listNetworkPolicies(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNetworkPoliciesPagedCallable()

  • listNetworkPoliciesCallable()

CreateNetworkPolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createNetworkPolicyAsync(CreateNetworkPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createNetworkPolicyAsync(LocationName parent, NetworkPolicy networkPolicy, String networkPolicyId)

  • createNetworkPolicyAsync(String parent, NetworkPolicy networkPolicy, String networkPolicyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createNetworkPolicyOperationCallable()

  • createNetworkPolicyCallable()

UpdateNetworkPolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateNetworkPolicyAsync(UpdateNetworkPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateNetworkPolicyAsync(NetworkPolicy networkPolicy, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateNetworkPolicyOperationCallable()

  • updateNetworkPolicyCallable()

DeleteNetworkPolicy

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteNetworkPolicyAsync(DeleteNetworkPolicyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteNetworkPolicyAsync(NetworkPolicyName name)

  • deleteNetworkPolicyAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteNetworkPolicyOperationCallable()

  • deleteNetworkPolicyCallable()

ListManagementDnsZoneBindings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listManagementDnsZoneBindings(ListManagementDnsZoneBindingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listManagementDnsZoneBindings(PrivateCloudName parent)

  • listManagementDnsZoneBindings(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listManagementDnsZoneBindingsPagedCallable()

  • listManagementDnsZoneBindingsCallable()

GetManagementDnsZoneBinding

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getManagementDnsZoneBinding(GetManagementDnsZoneBindingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getManagementDnsZoneBinding(ManagementDnsZoneBindingName name)

  • getManagementDnsZoneBinding(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getManagementDnsZoneBindingCallable()

CreateManagementDnsZoneBinding

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createManagementDnsZoneBindingAsync(CreateManagementDnsZoneBindingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createManagementDnsZoneBindingAsync(PrivateCloudName parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

  • createManagementDnsZoneBindingAsync(String parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createManagementDnsZoneBindingOperationCallable()

  • createManagementDnsZoneBindingCallable()

UpdateManagementDnsZoneBinding

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateManagementDnsZoneBindingAsync(UpdateManagementDnsZoneBindingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateManagementDnsZoneBindingAsync(ManagementDnsZoneBinding managementDnsZoneBinding, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateManagementDnsZoneBindingOperationCallable()

  • updateManagementDnsZoneBindingCallable()

DeleteManagementDnsZoneBinding

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteManagementDnsZoneBindingAsync(DeleteManagementDnsZoneBindingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

  • deleteManagementDnsZoneBindingAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteManagementDnsZoneBindingOperationCallable()

  • deleteManagementDnsZoneBindingCallable()

RepairManagementDnsZoneBinding

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • repairManagementDnsZoneBindingAsync(RepairManagementDnsZoneBindingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • repairManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

  • repairManagementDnsZoneBindingAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • repairManagementDnsZoneBindingOperationCallable()

  • repairManagementDnsZoneBindingCallable()

CreateVmwareEngineNetwork

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createVmwareEngineNetworkAsync(LocationName parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

  • createVmwareEngineNetworkAsync(String parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createVmwareEngineNetworkOperationCallable()

  • createVmwareEngineNetworkCallable()

UpdateVmwareEngineNetwork

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateVmwareEngineNetworkAsync(VmwareEngineNetwork vmwareEngineNetwork, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateVmwareEngineNetworkOperationCallable()

  • updateVmwareEngineNetworkCallable()

DeleteVmwareEngineNetwork

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteVmwareEngineNetworkAsync(VmwareEngineNetworkName name)

  • deleteVmwareEngineNetworkAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteVmwareEngineNetworkOperationCallable()

  • deleteVmwareEngineNetworkCallable()

GetVmwareEngineNetwork

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).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getVmwareEngineNetwork(VmwareEngineNetworkName name)

  • getVmwareEngineNetwork(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getVmwareEngineNetworkCallable()

ListVmwareEngineNetworks

Lists VmwareEngineNetwork resources in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listVmwareEngineNetworks(LocationName parent)

  • listVmwareEngineNetworks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listVmwareEngineNetworksPagedCallable()

  • listVmwareEngineNetworksCallable()

CreatePrivateConnection

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPrivateConnectionAsync(CreatePrivateConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createPrivateConnectionAsync(LocationName parent, PrivateConnection privateConnection, String privateConnectionId)

  • createPrivateConnectionAsync(String parent, PrivateConnection privateConnection, String privateConnectionId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPrivateConnectionOperationCallable()

  • createPrivateConnectionCallable()

GetPrivateConnection

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPrivateConnection(GetPrivateConnectionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPrivateConnection(PrivateConnectionName name)

  • getPrivateConnection(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPrivateConnectionCallable()

ListPrivateConnections

Lists PrivateConnection resources in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPrivateConnections(ListPrivateConnectionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrivateConnections(LocationName parent)

  • listPrivateConnections(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPrivateConnectionsPagedCallable()

  • listPrivateConnectionsCallable()

UpdatePrivateConnection

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePrivateConnectionAsync(UpdatePrivateConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updatePrivateConnectionAsync(PrivateConnection privateConnection, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePrivateConnectionOperationCallable()

  • updatePrivateConnectionCallable()

DeletePrivateConnection

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePrivateConnectionAsync(DeletePrivateConnectionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deletePrivateConnectionAsync(PrivateConnectionName name)

  • deletePrivateConnectionAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePrivateConnectionOperationCallable()

  • deletePrivateConnectionCallable()

ListPrivateConnectionPeeringRoutes

Lists the private connection routes exchanged over a peering connection.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPrivateConnectionPeeringRoutes(PrivateConnectionName parent)

  • listPrivateConnectionPeeringRoutes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPrivateConnectionPeeringRoutesPagedCallable()

  • listPrivateConnectionPeeringRoutesCallable()

GrantDnsBindPermission

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • grantDnsBindPermissionAsync(GrantDnsBindPermissionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • grantDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

  • grantDnsBindPermissionAsync(String name, Principal principal)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • grantDnsBindPermissionOperationCallable()

  • grantDnsBindPermissionCallable()

GetDnsBindPermission

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDnsBindPermission(GetDnsBindPermissionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDnsBindPermission(DnsBindPermissionName name)

  • getDnsBindPermission(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDnsBindPermissionCallable()

RevokeDnsBindPermission

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • revokeDnsBindPermissionAsync(RevokeDnsBindPermissionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • revokeDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

  • revokeDnsBindPermissionAsync(String name, Principal principal)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • revokeDnsBindPermissionOperationCallable()

  • revokeDnsBindPermissionCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VmwareEngineSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VmwareEngineSettings vmwareEngineSettings =
     VmwareEngineSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create(vmwareEngineSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VmwareEngineSettings vmwareEngineSettings =
     VmwareEngineSettings.newBuilder().setEndpoint(myEndpoint).build();
 VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create(vmwareEngineSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VmwareEngineSettings vmwareEngineSettings = VmwareEngineSettings.newHttpJsonBuilder().build();
 VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create(vmwareEngineSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VmwareEngineClient

Static Methods

create()

public static final VmwareEngineClient create()

Constructs an instance of VmwareEngineClient with default settings.

Returns
Type Description
VmwareEngineClient
Exceptions
Type Description
IOException

create(VmwareEngineSettings settings)

public static final VmwareEngineClient create(VmwareEngineSettings settings)

Constructs an instance of VmwareEngineClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings VmwareEngineSettings
Returns
Type Description
VmwareEngineClient
Exceptions
Type Description
IOException

create(VmwareEngineStub stub)

public static final VmwareEngineClient create(VmwareEngineStub stub)

Constructs an instance of VmwareEngineClient, using the given stub for making calls. This is for advanced usage - prefer using create(VmwareEngineSettings).

Parameter
Name Description
stub VmwareEngineStub
Returns
Type Description
VmwareEngineClient

Constructors

VmwareEngineClient(VmwareEngineSettings settings)

protected VmwareEngineClient(VmwareEngineSettings settings)

Constructs an instance of VmwareEngineClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings VmwareEngineSettings

VmwareEngineClient(VmwareEngineStub stub)

protected VmwareEngineClient(VmwareEngineStub stub)
Parameter
Name Description
stub VmwareEngineStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createClusterAsync(CreateClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(CreateClusterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   Cluster response = vmwareEngineClient.createClusterAsync(request).get();
 }
 
Parameter
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

createClusterAsync(PrivateCloudName parent, Cluster cluster, String clusterId)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(PrivateCloudName parent, Cluster cluster, String clusterId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = vmwareEngineClient.createClusterAsync(parent, cluster, clusterId).get();
 }
 
Parameters
Name Description
parent PrivateCloudName

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 Cluster

Required. The initial description of the new cluster.

clusterId String

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)

Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

createClusterAsync(String parent, Cluster cluster, String clusterId)

public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(String parent, Cluster cluster, String clusterId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = vmwareEngineClient.createClusterAsync(parent, cluster, clusterId).get();
 }
 
Parameters
Name Description
parent String

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 Cluster

Required. The initial description of the new cluster.

clusterId String

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)

Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

createClusterCallable()

public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = vmwareEngineClient.createClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateClusterRequest,Operation>

createClusterOperationCallable()

public final OperationCallable<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       vmwareEngineClient.createClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateClusterRequest,Cluster,OperationMetadata>

createExternalAccessRuleAsync(CreateExternalAccessRuleRequest request)

public final OperationFuture<ExternalAccessRule,OperationMetadata> createExternalAccessRuleAsync(CreateExternalAccessRuleRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAccessRuleRequest request =
       CreateExternalAccessRuleRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setExternalAccessRuleId("externalAccessRuleId1937389350")
           .setRequestId("requestId693933066")
           .build();
   ExternalAccessRule response = vmwareEngineClient.createExternalAccessRuleAsync(request).get();
 }
 
Parameter
Name Description
request CreateExternalAccessRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ExternalAccessRule,OperationMetadata>

createExternalAccessRuleAsync(NetworkPolicyName parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

public final OperationFuture<ExternalAccessRule,OperationMetadata> createExternalAccessRuleAsync(NetworkPolicyName parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicyName parent =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]");
   ExternalAccessRule externalAccessRule = ExternalAccessRule.newBuilder().build();
   String externalAccessRuleId = "externalAccessRuleId1937389350";
   ExternalAccessRule response =
       vmwareEngineClient
           .createExternalAccessRuleAsync(parent, externalAccessRule, externalAccessRuleId)
           .get();
 }
 
Parameters
Name Description
parent NetworkPolicyName

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

externalAccessRule ExternalAccessRule

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

externalAccessRuleId String

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)

Returns
Type Description
OperationFuture<ExternalAccessRule,OperationMetadata>

createExternalAccessRuleAsync(String parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

public final OperationFuture<ExternalAccessRule,OperationMetadata> createExternalAccessRuleAsync(String parent, ExternalAccessRule externalAccessRule, String externalAccessRuleId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString();
   ExternalAccessRule externalAccessRule = ExternalAccessRule.newBuilder().build();
   String externalAccessRuleId = "externalAccessRuleId1937389350";
   ExternalAccessRule response =
       vmwareEngineClient
           .createExternalAccessRuleAsync(parent, externalAccessRule, externalAccessRuleId)
           .get();
 }
 
Parameters
Name Description
parent String

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

externalAccessRule ExternalAccessRule

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

externalAccessRuleId String

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)

Returns
Type Description
OperationFuture<ExternalAccessRule,OperationMetadata>

createExternalAccessRuleCallable()

public final UnaryCallable<CreateExternalAccessRuleRequest,Operation> createExternalAccessRuleCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAccessRuleRequest request =
       CreateExternalAccessRuleRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setExternalAccessRuleId("externalAccessRuleId1937389350")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createExternalAccessRuleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateExternalAccessRuleRequest,Operation>

createExternalAccessRuleOperationCallable()

public final OperationCallable<CreateExternalAccessRuleRequest,ExternalAccessRule,OperationMetadata> createExternalAccessRuleOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAccessRuleRequest request =
       CreateExternalAccessRuleRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setExternalAccessRuleId("externalAccessRuleId1937389350")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ExternalAccessRule, OperationMetadata> future =
       vmwareEngineClient.createExternalAccessRuleOperationCallable().futureCall(request);
   // Do something.
   ExternalAccessRule response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateExternalAccessRuleRequest,ExternalAccessRule,OperationMetadata>

createExternalAddressAsync(CreateExternalAddressRequest request)

public final OperationFuture<ExternalAddress,OperationMetadata> createExternalAddressAsync(CreateExternalAddressRequest request)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAddressRequest request =
       CreateExternalAddressRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setExternalAddressId("externalAddressId221595812")
           .setRequestId("requestId693933066")
           .build();
   ExternalAddress response = vmwareEngineClient.createExternalAddressAsync(request).get();
 }
 
Parameter
Name Description
request CreateExternalAddressRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ExternalAddress,OperationMetadata>

createExternalAddressAsync(PrivateCloudName parent, ExternalAddress externalAddress, String externalAddressId)

public final OperationFuture<ExternalAddress,OperationMetadata> createExternalAddressAsync(PrivateCloudName parent, ExternalAddress externalAddress, String externalAddressId)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   ExternalAddress externalAddress = ExternalAddress.newBuilder().build();
   String externalAddressId = "externalAddressId221595812";
   ExternalAddress response =
       vmwareEngineClient
           .createExternalAddressAsync(parent, externalAddress, externalAddressId)
           .get();
 }
 
Parameters
Name Description
parent PrivateCloudName

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

externalAddress ExternalAddress

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

externalAddressId String

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)

Returns
Type Description
OperationFuture<ExternalAddress,OperationMetadata>

createExternalAddressAsync(String parent, ExternalAddress externalAddress, String externalAddressId)

public final OperationFuture<ExternalAddress,OperationMetadata> createExternalAddressAsync(String parent, ExternalAddress externalAddress, String externalAddressId)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   ExternalAddress externalAddress = ExternalAddress.newBuilder().build();
   String externalAddressId = "externalAddressId221595812";
   ExternalAddress response =
       vmwareEngineClient
           .createExternalAddressAsync(parent, externalAddress, externalAddressId)
           .get();
 }
 
Parameters
Name Description
parent String

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

externalAddress ExternalAddress

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

externalAddressId String

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)

Returns
Type Description
OperationFuture<ExternalAddress,OperationMetadata>

createExternalAddressCallable()

public final UnaryCallable<CreateExternalAddressRequest,Operation> createExternalAddressCallable()

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAddressRequest request =
       CreateExternalAddressRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setExternalAddressId("externalAddressId221595812")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createExternalAddressCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateExternalAddressRequest,Operation>

createExternalAddressOperationCallable()

public final OperationCallable<CreateExternalAddressRequest,ExternalAddress,OperationMetadata> createExternalAddressOperationCallable()

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateExternalAddressRequest request =
       CreateExternalAddressRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setExternalAddressId("externalAddressId221595812")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ExternalAddress, OperationMetadata> future =
       vmwareEngineClient.createExternalAddressOperationCallable().futureCall(request);
   // Do something.
   ExternalAddress response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateExternalAddressRequest,ExternalAddress,OperationMetadata>

createHcxActivationKeyAsync(CreateHcxActivationKeyRequest request)

public final OperationFuture<HcxActivationKey,OperationMetadata> createHcxActivationKeyAsync(CreateHcxActivationKeyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateHcxActivationKeyRequest request =
       CreateHcxActivationKeyRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setHcxActivationKey(HcxActivationKey.newBuilder().build())
           .setHcxActivationKeyId("hcxActivationKeyId-645871673")
           .setRequestId("requestId693933066")
           .build();
   HcxActivationKey response = vmwareEngineClient.createHcxActivationKeyAsync(request).get();
 }
 
Parameter
Name Description
request CreateHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<HcxActivationKey,OperationMetadata>

createHcxActivationKeyAsync(PrivateCloudName parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

public final OperationFuture<HcxActivationKey,OperationMetadata> createHcxActivationKeyAsync(PrivateCloudName parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   HcxActivationKey hcxActivationKey = HcxActivationKey.newBuilder().build();
   String hcxActivationKeyId = "hcxActivationKeyId-645871673";
   HcxActivationKey response =
       vmwareEngineClient
           .createHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId)
           .get();
 }
 
Parameters
Name Description
parent PrivateCloudName

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

hcxActivationKey HcxActivationKey

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

hcxActivationKeyId String

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)

Returns
Type Description
OperationFuture<HcxActivationKey,OperationMetadata>

createHcxActivationKeyAsync(String parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

public final OperationFuture<HcxActivationKey,OperationMetadata> createHcxActivationKeyAsync(String parent, HcxActivationKey hcxActivationKey, String hcxActivationKeyId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   HcxActivationKey hcxActivationKey = HcxActivationKey.newBuilder().build();
   String hcxActivationKeyId = "hcxActivationKeyId-645871673";
   HcxActivationKey response =
       vmwareEngineClient
           .createHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId)
           .get();
 }
 
Parameters
Name Description
parent String

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

hcxActivationKey HcxActivationKey

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

hcxActivationKeyId String

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)

Returns
Type Description
OperationFuture<HcxActivationKey,OperationMetadata>

createHcxActivationKeyCallable()

public final UnaryCallable<CreateHcxActivationKeyRequest,Operation> createHcxActivationKeyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateHcxActivationKeyRequest request =
       CreateHcxActivationKeyRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setHcxActivationKey(HcxActivationKey.newBuilder().build())
           .setHcxActivationKeyId("hcxActivationKeyId-645871673")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createHcxActivationKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateHcxActivationKeyRequest,Operation>

createHcxActivationKeyOperationCallable()

public final OperationCallable<CreateHcxActivationKeyRequest,HcxActivationKey,OperationMetadata> createHcxActivationKeyOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateHcxActivationKeyRequest request =
       CreateHcxActivationKeyRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setHcxActivationKey(HcxActivationKey.newBuilder().build())
           .setHcxActivationKeyId("hcxActivationKeyId-645871673")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<HcxActivationKey, OperationMetadata> future =
       vmwareEngineClient.createHcxActivationKeyOperationCallable().futureCall(request);
   // Do something.
   HcxActivationKey response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateHcxActivationKeyRequest,HcxActivationKey,OperationMetadata>

createLoggingServerAsync(CreateLoggingServerRequest request)

public final OperationFuture<LoggingServer,OperationMetadata> createLoggingServerAsync(CreateLoggingServerRequest request)

Create a new logging server for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateLoggingServerRequest request =
       CreateLoggingServerRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setLoggingServerId("loggingServerId-304163779")
           .setRequestId("requestId693933066")
           .build();
   LoggingServer response = vmwareEngineClient.createLoggingServerAsync(request).get();
 }
 
Parameter
Name Description
request CreateLoggingServerRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<LoggingServer,OperationMetadata>

createLoggingServerAsync(PrivateCloudName parent, LoggingServer loggingServer, String loggingServerId)

public final OperationFuture<LoggingServer,OperationMetadata> createLoggingServerAsync(PrivateCloudName parent, LoggingServer loggingServer, String loggingServerId)

Create a new logging server for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   LoggingServer loggingServer = LoggingServer.newBuilder().build();
   String loggingServerId = "loggingServerId-304163779";
   LoggingServer response =
       vmwareEngineClient.createLoggingServerAsync(parent, loggingServer, loggingServerId).get();
 }
 
Parameters
Name Description
parent PrivateCloudName

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

loggingServer LoggingServer

Required. The initial description of a new logging server.

loggingServerId String

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)

Returns
Type Description
OperationFuture<LoggingServer,OperationMetadata>

createLoggingServerAsync(String parent, LoggingServer loggingServer, String loggingServerId)

public final OperationFuture<LoggingServer,OperationMetadata> createLoggingServerAsync(String parent, LoggingServer loggingServer, String loggingServerId)

Create a new logging server for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   LoggingServer loggingServer = LoggingServer.newBuilder().build();
   String loggingServerId = "loggingServerId-304163779";
   LoggingServer response =
       vmwareEngineClient.createLoggingServerAsync(parent, loggingServer, loggingServerId).get();
 }
 
Parameters
Name Description
parent String

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

loggingServer LoggingServer

Required. The initial description of a new logging server.

loggingServerId String

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)

Returns
Type Description
OperationFuture<LoggingServer,OperationMetadata>

createLoggingServerCallable()

public final UnaryCallable<CreateLoggingServerRequest,Operation> createLoggingServerCallable()

Create a new logging server for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateLoggingServerRequest request =
       CreateLoggingServerRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setLoggingServerId("loggingServerId-304163779")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createLoggingServerCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateLoggingServerRequest,Operation>

createLoggingServerOperationCallable()

public final OperationCallable<CreateLoggingServerRequest,LoggingServer,OperationMetadata> createLoggingServerOperationCallable()

Create a new logging server for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateLoggingServerRequest request =
       CreateLoggingServerRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setLoggingServerId("loggingServerId-304163779")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<LoggingServer, OperationMetadata> future =
       vmwareEngineClient.createLoggingServerOperationCallable().futureCall(request);
   // Do something.
   LoggingServer response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateLoggingServerRequest,LoggingServer,OperationMetadata>

createManagementDnsZoneBindingAsync(CreateManagementDnsZoneBindingRequest request)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> createManagementDnsZoneBindingAsync(CreateManagementDnsZoneBindingRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateManagementDnsZoneBindingRequest request =
       CreateManagementDnsZoneBindingRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setManagementDnsZoneBindingId("managementDnsZoneBindingId-288984082")
           .setRequestId("requestId693933066")
           .build();
   ManagementDnsZoneBinding response =
       vmwareEngineClient.createManagementDnsZoneBindingAsync(request).get();
 }
 
Parameter
Name Description
request CreateManagementDnsZoneBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

createManagementDnsZoneBindingAsync(PrivateCloudName parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> createManagementDnsZoneBindingAsync(PrivateCloudName parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   ManagementDnsZoneBinding managementDnsZoneBinding =
       ManagementDnsZoneBinding.newBuilder().build();
   String managementDnsZoneBindingId = "managementDnsZoneBindingId-288984082";
   ManagementDnsZoneBinding response =
       vmwareEngineClient
           .createManagementDnsZoneBindingAsync(
               parent, managementDnsZoneBinding, managementDnsZoneBindingId)
           .get();
 }
 
Parameters
Name Description
parent PrivateCloudName

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

managementDnsZoneBinding ManagementDnsZoneBinding

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

managementDnsZoneBindingId String

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)

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

createManagementDnsZoneBindingAsync(String parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> createManagementDnsZoneBindingAsync(String parent, ManagementDnsZoneBinding managementDnsZoneBinding, String managementDnsZoneBindingId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   ManagementDnsZoneBinding managementDnsZoneBinding =
       ManagementDnsZoneBinding.newBuilder().build();
   String managementDnsZoneBindingId = "managementDnsZoneBindingId-288984082";
   ManagementDnsZoneBinding response =
       vmwareEngineClient
           .createManagementDnsZoneBindingAsync(
               parent, managementDnsZoneBinding, managementDnsZoneBindingId)
           .get();
 }
 
Parameters
Name Description
parent String

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

managementDnsZoneBinding ManagementDnsZoneBinding

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

managementDnsZoneBindingId String

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)

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

createManagementDnsZoneBindingCallable()

public final UnaryCallable<CreateManagementDnsZoneBindingRequest,Operation> createManagementDnsZoneBindingCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateManagementDnsZoneBindingRequest request =
       CreateManagementDnsZoneBindingRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setManagementDnsZoneBindingId("managementDnsZoneBindingId-288984082")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createManagementDnsZoneBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateManagementDnsZoneBindingRequest,Operation>

createManagementDnsZoneBindingOperationCallable()

public final OperationCallable<CreateManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata> createManagementDnsZoneBindingOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateManagementDnsZoneBindingRequest request =
       CreateManagementDnsZoneBindingRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setManagementDnsZoneBindingId("managementDnsZoneBindingId-288984082")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ManagementDnsZoneBinding, OperationMetadata> future =
       vmwareEngineClient.createManagementDnsZoneBindingOperationCallable().futureCall(request);
   // Do something.
   ManagementDnsZoneBinding response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata>

createNetworkPeeringAsync(CreateNetworkPeeringRequest request)

public final OperationFuture<NetworkPeering,OperationMetadata> createNetworkPeeringAsync(CreateNetworkPeeringRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPeeringRequest request =
       CreateNetworkPeeringRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPeeringId("networkPeeringId1321772525")
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NetworkPeering response = vmwareEngineClient.createNetworkPeeringAsync(request).get();
 }
 
Parameter
Name Description
request CreateNetworkPeeringRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NetworkPeering,OperationMetadata>

createNetworkPeeringAsync(LocationName parent, NetworkPeering networkPeering, String networkPeeringId)

public final OperationFuture<NetworkPeering,OperationMetadata> createNetworkPeeringAsync(LocationName parent, NetworkPeering networkPeering, String networkPeeringId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   NetworkPeering networkPeering = NetworkPeering.newBuilder().build();
   String networkPeeringId = "networkPeeringId1321772525";
   NetworkPeering response =
       vmwareEngineClient
           .createNetworkPeeringAsync(parent, networkPeering, networkPeeringId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

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

networkPeering NetworkPeering

Required. The initial description of the new network peering.

networkPeeringId String

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)

Returns
Type Description
OperationFuture<NetworkPeering,OperationMetadata>

createNetworkPeeringAsync(String parent, NetworkPeering networkPeering, String networkPeeringId)

public final OperationFuture<NetworkPeering,OperationMetadata> createNetworkPeeringAsync(String parent, NetworkPeering networkPeering, String networkPeeringId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   NetworkPeering networkPeering = NetworkPeering.newBuilder().build();
   String networkPeeringId = "networkPeeringId1321772525";
   NetworkPeering response =
       vmwareEngineClient
           .createNetworkPeeringAsync(parent, networkPeering, networkPeeringId)
           .get();
 }
 
Parameters
Name Description
parent String

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

networkPeering NetworkPeering

Required. The initial description of the new network peering.

networkPeeringId String

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)

Returns
Type Description
OperationFuture<NetworkPeering,OperationMetadata>

createNetworkPeeringCallable()

public final UnaryCallable<CreateNetworkPeeringRequest,Operation> createNetworkPeeringCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPeeringRequest request =
       CreateNetworkPeeringRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPeeringId("networkPeeringId1321772525")
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createNetworkPeeringCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateNetworkPeeringRequest,Operation>

createNetworkPeeringOperationCallable()

public final OperationCallable<CreateNetworkPeeringRequest,NetworkPeering,OperationMetadata> createNetworkPeeringOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPeeringRequest request =
       CreateNetworkPeeringRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPeeringId("networkPeeringId1321772525")
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NetworkPeering, OperationMetadata> future =
       vmwareEngineClient.createNetworkPeeringOperationCallable().futureCall(request);
   // Do something.
   NetworkPeering response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateNetworkPeeringRequest,NetworkPeering,OperationMetadata>

createNetworkPolicyAsync(CreateNetworkPolicyRequest request)

public final OperationFuture<NetworkPolicy,OperationMetadata> createNetworkPolicyAsync(CreateNetworkPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPolicyRequest request =
       CreateNetworkPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPolicyId("networkPolicyId-727262661")
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NetworkPolicy response = vmwareEngineClient.createNetworkPolicyAsync(request).get();
 }
 
Parameter
Name Description
request CreateNetworkPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NetworkPolicy,OperationMetadata>

createNetworkPolicyAsync(LocationName parent, NetworkPolicy networkPolicy, String networkPolicyId)

public final OperationFuture<NetworkPolicy,OperationMetadata> createNetworkPolicyAsync(LocationName parent, NetworkPolicy networkPolicy, String networkPolicyId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   NetworkPolicy networkPolicy = NetworkPolicy.newBuilder().build();
   String networkPolicyId = "networkPolicyId-727262661";
   NetworkPolicy response =
       vmwareEngineClient.createNetworkPolicyAsync(parent, networkPolicy, networkPolicyId).get();
 }
 
Parameters
Name Description
parent LocationName

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

networkPolicy NetworkPolicy

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

networkPolicyId String

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)

Returns
Type Description
OperationFuture<NetworkPolicy,OperationMetadata>

createNetworkPolicyAsync(String parent, NetworkPolicy networkPolicy, String networkPolicyId)

public final OperationFuture<NetworkPolicy,OperationMetadata> createNetworkPolicyAsync(String parent, NetworkPolicy networkPolicy, String networkPolicyId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   NetworkPolicy networkPolicy = NetworkPolicy.newBuilder().build();
   String networkPolicyId = "networkPolicyId-727262661";
   NetworkPolicy response =
       vmwareEngineClient.createNetworkPolicyAsync(parent, networkPolicy, networkPolicyId).get();
 }
 
Parameters
Name Description
parent String

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

networkPolicy NetworkPolicy

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

networkPolicyId String

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)

Returns
Type Description
OperationFuture<NetworkPolicy,OperationMetadata>

createNetworkPolicyCallable()

public final UnaryCallable<CreateNetworkPolicyRequest,Operation> createNetworkPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPolicyRequest request =
       CreateNetworkPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPolicyId("networkPolicyId-727262661")
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createNetworkPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateNetworkPolicyRequest,Operation>

createNetworkPolicyOperationCallable()

public final OperationCallable<CreateNetworkPolicyRequest,NetworkPolicy,OperationMetadata> createNetworkPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateNetworkPolicyRequest request =
       CreateNetworkPolicyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNetworkPolicyId("networkPolicyId-727262661")
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NetworkPolicy, OperationMetadata> future =
       vmwareEngineClient.createNetworkPolicyOperationCallable().futureCall(request);
   // Do something.
   NetworkPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>

createPrivateCloudAsync(CreatePrivateCloudRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> createPrivateCloudAsync(CreatePrivateCloudRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateCloudRequest request =
       CreatePrivateCloudRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateCloudId("privateCloudId573896493")
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   PrivateCloud response = vmwareEngineClient.createPrivateCloudAsync(request).get();
 }
 
Parameter
Name Description
request CreatePrivateCloudRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

createPrivateCloudAsync(LocationName parent, PrivateCloud privateCloud, String privateCloudId)

public final OperationFuture<PrivateCloud,OperationMetadata> createPrivateCloudAsync(LocationName parent, PrivateCloud privateCloud, String privateCloudId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PrivateCloud privateCloud = PrivateCloud.newBuilder().build();
   String privateCloudId = "privateCloudId573896493";
   PrivateCloud response =
       vmwareEngineClient.createPrivateCloudAsync(parent, privateCloud, privateCloudId).get();
 }
 
Parameters
Name Description
parent LocationName

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

privateCloud PrivateCloud

Required. The initial description of the new private cloud.

privateCloudId String

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)

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

createPrivateCloudAsync(String parent, PrivateCloud privateCloud, String privateCloudId)

public final OperationFuture<PrivateCloud,OperationMetadata> createPrivateCloudAsync(String parent, PrivateCloud privateCloud, String privateCloudId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PrivateCloud privateCloud = PrivateCloud.newBuilder().build();
   String privateCloudId = "privateCloudId573896493";
   PrivateCloud response =
       vmwareEngineClient.createPrivateCloudAsync(parent, privateCloud, privateCloudId).get();
 }
 
Parameters
Name Description
parent String

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

privateCloud PrivateCloud

Required. The initial description of the new private cloud.

privateCloudId String

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)

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

createPrivateCloudCallable()

public final UnaryCallable<CreatePrivateCloudRequest,Operation> createPrivateCloudCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateCloudRequest request =
       CreatePrivateCloudRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateCloudId("privateCloudId573896493")
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createPrivateCloudCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePrivateCloudRequest,Operation>

createPrivateCloudOperationCallable()

public final OperationCallable<CreatePrivateCloudRequest,PrivateCloud,OperationMetadata> createPrivateCloudOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateCloudRequest request =
       CreatePrivateCloudRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateCloudId("privateCloudId573896493")
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.createPrivateCloudOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreatePrivateCloudRequest,PrivateCloud,OperationMetadata>

createPrivateConnectionAsync(CreatePrivateConnectionRequest request)

public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(CreatePrivateConnectionRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateConnectionRequest request =
       CreatePrivateConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateConnectionId("privateConnectionId-1926654532")
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   PrivateConnection response = vmwareEngineClient.createPrivateConnectionAsync(request).get();
 }
 
Parameter
Name Description
request CreatePrivateConnectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateConnection,OperationMetadata>

createPrivateConnectionAsync(LocationName parent, PrivateConnection privateConnection, String privateConnectionId)

public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(LocationName parent, PrivateConnection privateConnection, String privateConnectionId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PrivateConnection privateConnection = PrivateConnection.newBuilder().build();
   String privateConnectionId = "privateConnectionId-1926654532";
   PrivateConnection response =
       vmwareEngineClient
           .createPrivateConnectionAsync(parent, privateConnection, privateConnectionId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

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

privateConnection PrivateConnection

Required. The initial description of the new private connection.

privateConnectionId String

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)

Returns
Type Description
OperationFuture<PrivateConnection,OperationMetadata>

createPrivateConnectionAsync(String parent, PrivateConnection privateConnection, String privateConnectionId)

public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(String parent, PrivateConnection privateConnection, String privateConnectionId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PrivateConnection privateConnection = PrivateConnection.newBuilder().build();
   String privateConnectionId = "privateConnectionId-1926654532";
   PrivateConnection response =
       vmwareEngineClient
           .createPrivateConnectionAsync(parent, privateConnection, privateConnectionId)
           .get();
 }
 
Parameters
Name Description
parent String

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

privateConnection PrivateConnection

Required. The initial description of the new private connection.

privateConnectionId String

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)

Returns
Type Description
OperationFuture<PrivateConnection,OperationMetadata>

createPrivateConnectionCallable()

public final UnaryCallable<CreatePrivateConnectionRequest,Operation> createPrivateConnectionCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateConnectionRequest request =
       CreatePrivateConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateConnectionId("privateConnectionId-1926654532")
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createPrivateConnectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePrivateConnectionRequest,Operation>

createPrivateConnectionOperationCallable()

public final OperationCallable<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata> createPrivateConnectionOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreatePrivateConnectionRequest request =
       CreatePrivateConnectionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrivateConnectionId("privateConnectionId-1926654532")
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PrivateConnection, OperationMetadata> future =
       vmwareEngineClient.createPrivateConnectionOperationCallable().futureCall(request);
   // Do something.
   PrivateConnection response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata>

createVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest request)

public final OperationFuture<VmwareEngineNetwork,OperationMetadata> createVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateVmwareEngineNetworkRequest request =
       CreateVmwareEngineNetworkRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVmwareEngineNetworkId("vmwareEngineNetworkId532532083")
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   VmwareEngineNetwork response =
       vmwareEngineClient.createVmwareEngineNetworkAsync(request).get();
 }
 
Parameter
Name Description
request CreateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<VmwareEngineNetwork,OperationMetadata>

createVmwareEngineNetworkAsync(LocationName parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

public final OperationFuture<VmwareEngineNetwork,OperationMetadata> createVmwareEngineNetworkAsync(LocationName parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   VmwareEngineNetwork vmwareEngineNetwork = VmwareEngineNetwork.newBuilder().build();
   String vmwareEngineNetworkId = "vmwareEngineNetworkId532532083";
   VmwareEngineNetwork response =
       vmwareEngineClient
           .createVmwareEngineNetworkAsync(parent, vmwareEngineNetwork, vmwareEngineNetworkId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

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

vmwareEngineNetwork VmwareEngineNetwork

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

vmwareEngineNetworkId String

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)

Returns
Type Description
OperationFuture<VmwareEngineNetwork,OperationMetadata>

createVmwareEngineNetworkAsync(String parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

public final OperationFuture<VmwareEngineNetwork,OperationMetadata> createVmwareEngineNetworkAsync(String parent, VmwareEngineNetwork vmwareEngineNetwork, String vmwareEngineNetworkId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   VmwareEngineNetwork vmwareEngineNetwork = VmwareEngineNetwork.newBuilder().build();
   String vmwareEngineNetworkId = "vmwareEngineNetworkId532532083";
   VmwareEngineNetwork response =
       vmwareEngineClient
           .createVmwareEngineNetworkAsync(parent, vmwareEngineNetwork, vmwareEngineNetworkId)
           .get();
 }
 
Parameters
Name Description
parent String

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

vmwareEngineNetwork VmwareEngineNetwork

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

vmwareEngineNetworkId String

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)

Returns
Type Description
OperationFuture<VmwareEngineNetwork,OperationMetadata>

createVmwareEngineNetworkCallable()

public final UnaryCallable<CreateVmwareEngineNetworkRequest,Operation> createVmwareEngineNetworkCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateVmwareEngineNetworkRequest request =
       CreateVmwareEngineNetworkRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVmwareEngineNetworkId("vmwareEngineNetworkId532532083")
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.createVmwareEngineNetworkCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateVmwareEngineNetworkRequest,Operation>

createVmwareEngineNetworkOperationCallable()

public final OperationCallable<CreateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata> createVmwareEngineNetworkOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   CreateVmwareEngineNetworkRequest request =
       CreateVmwareEngineNetworkRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVmwareEngineNetworkId("vmwareEngineNetworkId532532083")
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<VmwareEngineNetwork, OperationMetadata> future =
       vmwareEngineClient.createVmwareEngineNetworkOperationCallable().futureCall(request);
   // Do something.
   VmwareEngineNetwork response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>

deleteClusterAsync(ClusterName name)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(ClusterName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]");
   vmwareEngineClient.deleteClusterAsync(name).get();
 }
 
Parameter
Name Description
name ClusterName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteClusterAsync(DeleteClusterRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(DeleteClusterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteClusterAsync(request).get();
 }
 
Parameter
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteClusterAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]").toString();
   vmwareEngineClient.deleteClusterAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteClusterCallable()

public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = vmwareEngineClient.deleteClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteClusterRequest,Operation>

deleteClusterOperationCallable()

public final OperationCallable<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteClusterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteClusterRequest,Empty,OperationMetadata>

deleteExternalAccessRuleAsync(DeleteExternalAccessRuleRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAccessRuleAsync(DeleteExternalAccessRuleRequest request)

Deletes a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAccessRuleRequest request =
       DeleteExternalAccessRuleRequest.newBuilder()
           .setName(
               ExternalAccessRuleName.of(
                       "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteExternalAccessRuleAsync(request).get();
 }
 
Parameter
Name Description
request DeleteExternalAccessRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAccessRuleAsync(ExternalAccessRuleName name)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAccessRuleAsync(ExternalAccessRuleName name)

Deletes a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAccessRuleName name =
       ExternalAccessRuleName.of(
           "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]");
   vmwareEngineClient.deleteExternalAccessRuleAsync(name).get();
 }
 
Parameter
Name Description
name ExternalAccessRuleName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAccessRuleAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAccessRuleAsync(String name)

Deletes a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ExternalAccessRuleName.of(
               "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
           .toString();
   vmwareEngineClient.deleteExternalAccessRuleAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAccessRuleCallable()

public final UnaryCallable<DeleteExternalAccessRuleRequest,Operation> deleteExternalAccessRuleCallable()

Deletes a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAccessRuleRequest request =
       DeleteExternalAccessRuleRequest.newBuilder()
           .setName(
               ExternalAccessRuleName.of(
                       "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteExternalAccessRuleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteExternalAccessRuleRequest,Operation>

deleteExternalAccessRuleOperationCallable()

public final OperationCallable<DeleteExternalAccessRuleRequest,Empty,OperationMetadata> deleteExternalAccessRuleOperationCallable()

Deletes a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAccessRuleRequest request =
       DeleteExternalAccessRuleRequest.newBuilder()
           .setName(
               ExternalAccessRuleName.of(
                       "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteExternalAccessRuleOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteExternalAccessRuleRequest,Empty,OperationMetadata>

deleteExternalAddressAsync(DeleteExternalAddressRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAddressAsync(DeleteExternalAddressRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAddressRequest request =
       DeleteExternalAddressRequest.newBuilder()
           .setName(
               ExternalAddressName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteExternalAddressAsync(request).get();
 }
 
Parameter
Name Description
request DeleteExternalAddressRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAddressAsync(ExternalAddressName name)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAddressAsync(ExternalAddressName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAddressName name =
       ExternalAddressName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]");
   vmwareEngineClient.deleteExternalAddressAsync(name).get();
 }
 
Parameter
Name Description
name ExternalAddressName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAddressAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteExternalAddressAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ExternalAddressName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
           .toString();
   vmwareEngineClient.deleteExternalAddressAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteExternalAddressCallable()

public final UnaryCallable<DeleteExternalAddressRequest,Operation> deleteExternalAddressCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAddressRequest request =
       DeleteExternalAddressRequest.newBuilder()
           .setName(
               ExternalAddressName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteExternalAddressCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteExternalAddressRequest,Operation>

deleteExternalAddressOperationCallable()

public final OperationCallable<DeleteExternalAddressRequest,Empty,OperationMetadata> deleteExternalAddressOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteExternalAddressRequest request =
       DeleteExternalAddressRequest.newBuilder()
           .setName(
               ExternalAddressName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteExternalAddressOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteExternalAddressRequest,Empty,OperationMetadata>

deleteLoggingServerAsync(DeleteLoggingServerRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteLoggingServerAsync(DeleteLoggingServerRequest request)

Deletes a single logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteLoggingServerRequest request =
       DeleteLoggingServerRequest.newBuilder()
           .setName(
               LoggingServerName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteLoggingServerAsync(request).get();
 }
 
Parameter
Name Description
request DeleteLoggingServerRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteLoggingServerAsync(LoggingServerName name)

public final OperationFuture<Empty,OperationMetadata> deleteLoggingServerAsync(LoggingServerName name)

Deletes a single logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LoggingServerName name =
       LoggingServerName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]");
   vmwareEngineClient.deleteLoggingServerAsync(name).get();
 }
 
Parameter
Name Description
name LoggingServerName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteLoggingServerAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteLoggingServerAsync(String name)

Deletes a single logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       LoggingServerName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
           .toString();
   vmwareEngineClient.deleteLoggingServerAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteLoggingServerCallable()

public final UnaryCallable<DeleteLoggingServerRequest,Operation> deleteLoggingServerCallable()

Deletes a single logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteLoggingServerRequest request =
       DeleteLoggingServerRequest.newBuilder()
           .setName(
               LoggingServerName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteLoggingServerCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteLoggingServerRequest,Operation>

deleteLoggingServerOperationCallable()

public final OperationCallable<DeleteLoggingServerRequest,Empty,OperationMetadata> deleteLoggingServerOperationCallable()

Deletes a single logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteLoggingServerRequest request =
       DeleteLoggingServerRequest.newBuilder()
           .setName(
               LoggingServerName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteLoggingServerOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteLoggingServerRequest,Empty,OperationMetadata>

deleteManagementDnsZoneBindingAsync(DeleteManagementDnsZoneBindingRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteManagementDnsZoneBindingAsync(DeleteManagementDnsZoneBindingRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteManagementDnsZoneBindingRequest request =
       DeleteManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteManagementDnsZoneBindingAsync(request).get();
 }
 
Parameter
Name Description
request DeleteManagementDnsZoneBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

public final OperationFuture<Empty,OperationMetadata> deleteManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ManagementDnsZoneBindingName name =
       ManagementDnsZoneBindingName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]");
   vmwareEngineClient.deleteManagementDnsZoneBindingAsync(name).get();
 }
 
Parameter
Name Description
name ManagementDnsZoneBindingName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteManagementDnsZoneBindingAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteManagementDnsZoneBindingAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ManagementDnsZoneBindingName.of(
               "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]")
           .toString();
   vmwareEngineClient.deleteManagementDnsZoneBindingAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteManagementDnsZoneBindingCallable()

public final UnaryCallable<DeleteManagementDnsZoneBindingRequest,Operation> deleteManagementDnsZoneBindingCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteManagementDnsZoneBindingRequest request =
       DeleteManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteManagementDnsZoneBindingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteManagementDnsZoneBindingRequest,Operation>

deleteManagementDnsZoneBindingOperationCallable()

public final OperationCallable<DeleteManagementDnsZoneBindingRequest,Empty,OperationMetadata> deleteManagementDnsZoneBindingOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteManagementDnsZoneBindingRequest request =
       DeleteManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteManagementDnsZoneBindingOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteManagementDnsZoneBindingRequest,Empty,OperationMetadata>

deleteNetworkPeeringAsync(DeleteNetworkPeeringRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPeeringAsync(DeleteNetworkPeeringRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPeeringRequest request =
       DeleteNetworkPeeringRequest.newBuilder()
           .setName(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteNetworkPeeringAsync(request).get();
 }
 
Parameter
Name Description
request DeleteNetworkPeeringRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPeeringAsync(NetworkPeeringName name)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPeeringAsync(NetworkPeeringName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPeeringName name =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]");
   vmwareEngineClient.deleteNetworkPeeringAsync(name).get();
 }
 
Parameter
Name Description
name NetworkPeeringName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPeeringAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPeeringAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString();
   vmwareEngineClient.deleteNetworkPeeringAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPeeringCallable()

public final UnaryCallable<DeleteNetworkPeeringRequest,Operation> deleteNetworkPeeringCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPeeringRequest request =
       DeleteNetworkPeeringRequest.newBuilder()
           .setName(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteNetworkPeeringCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteNetworkPeeringRequest,Operation>

deleteNetworkPeeringOperationCallable()

public final OperationCallable<DeleteNetworkPeeringRequest,Empty,OperationMetadata> deleteNetworkPeeringOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPeeringRequest request =
       DeleteNetworkPeeringRequest.newBuilder()
           .setName(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteNetworkPeeringOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteNetworkPeeringRequest,Empty,OperationMetadata>

deleteNetworkPolicyAsync(DeleteNetworkPolicyRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPolicyAsync(DeleteNetworkPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPolicyRequest request =
       DeleteNetworkPolicyRequest.newBuilder()
           .setName(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deleteNetworkPolicyAsync(request).get();
 }
 
Parameter
Name Description
request DeleteNetworkPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPolicyAsync(NetworkPolicyName name)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPolicyAsync(NetworkPolicyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicyName name = NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]");
   vmwareEngineClient.deleteNetworkPolicyAsync(name).get();
 }
 
Parameter
Name Description
name NetworkPolicyName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPolicyAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteNetworkPolicyAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString();
   vmwareEngineClient.deleteNetworkPolicyAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNetworkPolicyCallable()

public final UnaryCallable<DeleteNetworkPolicyRequest,Operation> deleteNetworkPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPolicyRequest request =
       DeleteNetworkPolicyRequest.newBuilder()
           .setName(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteNetworkPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteNetworkPolicyRequest,Operation>

deleteNetworkPolicyOperationCallable()

public final OperationCallable<DeleteNetworkPolicyRequest,Empty,OperationMetadata> deleteNetworkPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteNetworkPolicyRequest request =
       DeleteNetworkPolicyRequest.newBuilder()
           .setName(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteNetworkPolicyOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteNetworkPolicyRequest,Empty,OperationMetadata>

deletePrivateCloudAsync(DeletePrivateCloudRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> deletePrivateCloudAsync(DeletePrivateCloudRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateCloudRequest request =
       DeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .setDelayHours(475821395)
           .build();
   PrivateCloud response = vmwareEngineClient.deletePrivateCloudAsync(request).get();
 }
 
Parameter
Name Description
request DeletePrivateCloudRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

deletePrivateCloudAsync(PrivateCloudName name)

public final OperationFuture<PrivateCloud,OperationMetadata> deletePrivateCloudAsync(PrivateCloudName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.deletePrivateCloudAsync(name).get();
 }
 
Parameter
Name Description
name PrivateCloudName

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

deletePrivateCloudAsync(String name)

public final OperationFuture<PrivateCloud,OperationMetadata> deletePrivateCloudAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   PrivateCloud response = vmwareEngineClient.deletePrivateCloudAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

deletePrivateCloudCallable()

public final UnaryCallable<DeletePrivateCloudRequest,Operation> deletePrivateCloudCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateCloudRequest request =
       DeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .setDelayHours(475821395)
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deletePrivateCloudCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePrivateCloudRequest,Operation>

deletePrivateCloudOperationCallable()

public final OperationCallable<DeletePrivateCloudRequest,PrivateCloud,OperationMetadata> deletePrivateCloudOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateCloudRequest request =
       DeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .setDelayHours(475821395)
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.deletePrivateCloudOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<DeletePrivateCloudRequest,PrivateCloud,OperationMetadata>

deletePrivateConnectionAsync(DeletePrivateConnectionRequest request)

public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(DeletePrivateConnectionRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateConnectionRequest request =
       DeletePrivateConnectionRequest.newBuilder()
           .setName(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   vmwareEngineClient.deletePrivateConnectionAsync(request).get();
 }
 
Parameter
Name Description
request DeletePrivateConnectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrivateConnectionAsync(PrivateConnectionName name)

public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(PrivateConnectionName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateConnectionName name =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]");
   vmwareEngineClient.deletePrivateConnectionAsync(name).get();
 }
 
Parameter
Name Description
name PrivateConnectionName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrivateConnectionAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]").toString();
   vmwareEngineClient.deletePrivateConnectionAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePrivateConnectionCallable()

public final UnaryCallable<DeletePrivateConnectionRequest,Operation> deletePrivateConnectionCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateConnectionRequest request =
       DeletePrivateConnectionRequest.newBuilder()
           .setName(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deletePrivateConnectionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePrivateConnectionRequest,Operation>

deletePrivateConnectionOperationCallable()

public final OperationCallable<DeletePrivateConnectionRequest,Empty,OperationMetadata> deletePrivateConnectionOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeletePrivateConnectionRequest request =
       DeletePrivateConnectionRequest.newBuilder()
           .setName(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deletePrivateConnectionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeletePrivateConnectionRequest,Empty,OperationMetadata>

deleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteVmwareEngineNetworkRequest request =
       DeleteVmwareEngineNetworkRequest.newBuilder()
           .setName(
               VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
                   .toString())
           .setRequestId("requestId693933066")
           .setEtag("etag3123477")
           .build();
   vmwareEngineClient.deleteVmwareEngineNetworkAsync(request).get();
 }
 
Parameter
Name Description
request DeleteVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVmwareEngineNetworkAsync(VmwareEngineNetworkName name)

public final OperationFuture<Empty,OperationMetadata> deleteVmwareEngineNetworkAsync(VmwareEngineNetworkName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   VmwareEngineNetworkName name =
       VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]");
   vmwareEngineClient.deleteVmwareEngineNetworkAsync(name).get();
 }
 
Parameter
Name Description
name VmwareEngineNetworkName

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVmwareEngineNetworkAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteVmwareEngineNetworkAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
           .toString();
   vmwareEngineClient.deleteVmwareEngineNetworkAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteVmwareEngineNetworkCallable()

public final UnaryCallable<DeleteVmwareEngineNetworkRequest,Operation> deleteVmwareEngineNetworkCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteVmwareEngineNetworkRequest request =
       DeleteVmwareEngineNetworkRequest.newBuilder()
           .setName(
               VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
                   .toString())
           .setRequestId("requestId693933066")
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.deleteVmwareEngineNetworkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteVmwareEngineNetworkRequest,Operation>

deleteVmwareEngineNetworkOperationCallable()

public final OperationCallable<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata> deleteVmwareEngineNetworkOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DeleteVmwareEngineNetworkRequest request =
       DeleteVmwareEngineNetworkRequest.newBuilder()
           .setName(
               VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
                   .toString())
           .setRequestId("requestId693933066")
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vmwareEngineClient.deleteVmwareEngineNetworkOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata>

fetchNetworkPolicyExternalAddresses(FetchNetworkPolicyExternalAddressesRequest request)

public final VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse fetchNetworkPolicyExternalAddresses(FetchNetworkPolicyExternalAddressesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   FetchNetworkPolicyExternalAddressesRequest request =
       FetchNetworkPolicyExternalAddressesRequest.newBuilder()
           .setNetworkPolicy(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ExternalAddress element :
       vmwareEngineClient.fetchNetworkPolicyExternalAddresses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request FetchNetworkPolicyExternalAddressesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse

fetchNetworkPolicyExternalAddresses(NetworkPolicyName networkPolicy)

public final VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse fetchNetworkPolicyExternalAddresses(NetworkPolicyName networkPolicy)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicyName networkPolicy =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]");
   for (ExternalAddress element :
       vmwareEngineClient.fetchNetworkPolicyExternalAddresses(networkPolicy).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
networkPolicy NetworkPolicyName

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

Returns
Type Description
VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse

fetchNetworkPolicyExternalAddresses(String networkPolicy)

public final VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse fetchNetworkPolicyExternalAddresses(String networkPolicy)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String networkPolicy =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString();
   for (ExternalAddress element :
       vmwareEngineClient.fetchNetworkPolicyExternalAddresses(networkPolicy).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
networkPolicy String

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

Returns
Type Description
VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse

fetchNetworkPolicyExternalAddressesCallable()

public final UnaryCallable<FetchNetworkPolicyExternalAddressesRequest,FetchNetworkPolicyExternalAddressesResponse> fetchNetworkPolicyExternalAddressesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   FetchNetworkPolicyExternalAddressesRequest request =
       FetchNetworkPolicyExternalAddressesRequest.newBuilder()
           .setNetworkPolicy(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     FetchNetworkPolicyExternalAddressesResponse response =
         vmwareEngineClient.fetchNetworkPolicyExternalAddressesCallable().call(request);
     for (ExternalAddress element : response.getExternalAddressesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<FetchNetworkPolicyExternalAddressesRequest,FetchNetworkPolicyExternalAddressesResponse>

fetchNetworkPolicyExternalAddressesPagedCallable()

public final UnaryCallable<FetchNetworkPolicyExternalAddressesRequest,VmwareEngineClient.FetchNetworkPolicyExternalAddressesPagedResponse> fetchNetworkPolicyExternalAddressesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   FetchNetworkPolicyExternalAddressesRequest request =
       FetchNetworkPolicyExternalAddressesRequest.newBuilder()
           .setNetworkPolicy(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ExternalAddress> future =
       vmwareEngineClient.fetchNetworkPolicyExternalAddressesPagedCallable().futureCall(request);
   // Do something.
   for (ExternalAddress element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<FetchNetworkPolicyExternalAddressesRequest,FetchNetworkPolicyExternalAddressesPagedResponse>

getCluster(ClusterName name)

public final Cluster getCluster(ClusterName name)

Retrieves a Cluster resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]");
   Cluster response = vmwareEngineClient.getCluster(name);
 }
 
Parameter
Name Description
name ClusterName

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

Returns
Type Description
Cluster

getCluster(GetClusterRequest request)

public final Cluster getCluster(GetClusterRequest request)

Retrieves a Cluster resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .build();
   Cluster response = vmwareEngineClient.getCluster(request);
 }
 
Parameter
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Cluster

getCluster(String name)

public final Cluster getCluster(String name)

Retrieves a Cluster resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]").toString();
   Cluster response = vmwareEngineClient.getCluster(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
Cluster

getClusterCallable()

public final UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()

Retrieves a Cluster resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .build();
   ApiFuture<Cluster> future = vmwareEngineClient.getClusterCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetClusterRequest,Cluster>

getDnsBindPermission(DnsBindPermissionName name)

public final DnsBindPermission getDnsBindPermission(DnsBindPermissionName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DnsBindPermissionName name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]");
   DnsBindPermission response = vmwareEngineClient.getDnsBindPermission(name);
 }
 
Parameter
Name Description
name DnsBindPermissionName

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

Returns
Type Description
DnsBindPermission

getDnsBindPermission(GetDnsBindPermissionRequest request)

public final DnsBindPermission getDnsBindPermission(GetDnsBindPermissionRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetDnsBindPermissionRequest request =
       GetDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   DnsBindPermission response = vmwareEngineClient.getDnsBindPermission(request);
 }
 
Parameter
Name Description
request GetDnsBindPermissionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DnsBindPermission

getDnsBindPermission(String name)

public final DnsBindPermission getDnsBindPermission(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString();
   DnsBindPermission response = vmwareEngineClient.getDnsBindPermission(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
DnsBindPermission

getDnsBindPermissionCallable()

public final UnaryCallable<GetDnsBindPermissionRequest,DnsBindPermission> getDnsBindPermissionCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetDnsBindPermissionRequest request =
       GetDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<DnsBindPermission> future =
       vmwareEngineClient.getDnsBindPermissionCallable().futureCall(request);
   // Do something.
   DnsBindPermission response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDnsBindPermissionRequest,DnsBindPermission>

getDnsForwarding(DnsForwardingName name)

public final DnsForwarding getDnsForwarding(DnsForwardingName name)

Gets details of the DnsForwarding config.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DnsForwardingName name = DnsForwardingName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   DnsForwarding response = vmwareEngineClient.getDnsForwarding(name);
 }
 
Parameter
Name Description
name DnsForwardingName

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

Returns
Type Description
DnsForwarding

getDnsForwarding(GetDnsForwardingRequest request)

public final DnsForwarding getDnsForwarding(GetDnsForwardingRequest request)

Gets details of the DnsForwarding config.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetDnsForwardingRequest request =
       GetDnsForwardingRequest.newBuilder()
           .setName(
               DnsForwardingName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   DnsForwarding response = vmwareEngineClient.getDnsForwarding(request);
 }
 
Parameter
Name Description
request GetDnsForwardingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DnsForwarding

getDnsForwarding(String name)

public final DnsForwarding getDnsForwarding(String name)

Gets details of the DnsForwarding config.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = DnsForwardingName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   DnsForwarding response = vmwareEngineClient.getDnsForwarding(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
DnsForwarding

getDnsForwardingCallable()

public final UnaryCallable<GetDnsForwardingRequest,DnsForwarding> getDnsForwardingCallable()

Gets details of the DnsForwarding config.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetDnsForwardingRequest request =
       GetDnsForwardingRequest.newBuilder()
           .setName(
               DnsForwardingName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   ApiFuture<DnsForwarding> future =
       vmwareEngineClient.getDnsForwardingCallable().futureCall(request);
   // Do something.
   DnsForwarding response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDnsForwardingRequest,DnsForwarding>

getExternalAccessRule(ExternalAccessRuleName name)

public final ExternalAccessRule getExternalAccessRule(ExternalAccessRuleName name)

Gets details of a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAccessRuleName name =
       ExternalAccessRuleName.of(
           "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]");
   ExternalAccessRule response = vmwareEngineClient.getExternalAccessRule(name);
 }
 
Parameter
Name Description
name ExternalAccessRuleName

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

Returns
Type Description
ExternalAccessRule

getExternalAccessRule(GetExternalAccessRuleRequest request)

public final ExternalAccessRule getExternalAccessRule(GetExternalAccessRuleRequest request)

Gets details of a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetExternalAccessRuleRequest request =
       GetExternalAccessRuleRequest.newBuilder()
           .setName(
               ExternalAccessRuleName.of(
                       "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
                   .toString())
           .build();
   ExternalAccessRule response = vmwareEngineClient.getExternalAccessRule(request);
 }
 
Parameter
Name Description
request GetExternalAccessRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ExternalAccessRule

getExternalAccessRule(String name)

public final ExternalAccessRule getExternalAccessRule(String name)

Gets details of a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ExternalAccessRuleName.of(
               "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
           .toString();
   ExternalAccessRule response = vmwareEngineClient.getExternalAccessRule(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
ExternalAccessRule

getExternalAccessRuleCallable()

public final UnaryCallable<GetExternalAccessRuleRequest,ExternalAccessRule> getExternalAccessRuleCallable()

Gets details of a single external access rule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetExternalAccessRuleRequest request =
       GetExternalAccessRuleRequest.newBuilder()
           .setName(
               ExternalAccessRuleName.of(
                       "[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]", "[EXTERNAL_ACCESS_RULE]")
                   .toString())
           .build();
   ApiFuture<ExternalAccessRule> future =
       vmwareEngineClient.getExternalAccessRuleCallable().futureCall(request);
   // Do something.
   ExternalAccessRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetExternalAccessRuleRequest,ExternalAccessRule>

getExternalAddress(ExternalAddressName name)

public final ExternalAddress getExternalAddress(ExternalAddressName name)

Gets details of a single external IP address.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAddressName name =
       ExternalAddressName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]");
   ExternalAddress response = vmwareEngineClient.getExternalAddress(name);
 }
 
Parameter
Name Description
name ExternalAddressName

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

Returns
Type Description
ExternalAddress

getExternalAddress(GetExternalAddressRequest request)

public final ExternalAddress getExternalAddress(GetExternalAddressRequest request)

Gets details of a single external IP address.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetExternalAddressRequest request =
       GetExternalAddressRequest.newBuilder()
           .setName(
               ExternalAddressName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
                   .toString())
           .build();
   ExternalAddress response = vmwareEngineClient.getExternalAddress(request);
 }
 
Parameter
Name Description
request GetExternalAddressRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ExternalAddress

getExternalAddress(String name)

public final ExternalAddress getExternalAddress(String name)

Gets details of a single external IP address.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ExternalAddressName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
           .toString();
   ExternalAddress response = vmwareEngineClient.getExternalAddress(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
ExternalAddress

getExternalAddressCallable()

public final UnaryCallable<GetExternalAddressRequest,ExternalAddress> getExternalAddressCallable()

Gets details of a single external IP address.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetExternalAddressRequest request =
       GetExternalAddressRequest.newBuilder()
           .setName(
               ExternalAddressName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[EXTERNAL_ADDRESS]")
                   .toString())
           .build();
   ApiFuture<ExternalAddress> future =
       vmwareEngineClient.getExternalAddressCallable().futureCall(request);
   // Do something.
   ExternalAddress response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetExternalAddressRequest,ExternalAddress>

getHcxActivationKey(GetHcxActivationKeyRequest request)

public final HcxActivationKey getHcxActivationKey(GetHcxActivationKeyRequest request)

Retrieves a HcxActivationKey resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetHcxActivationKeyRequest request =
       GetHcxActivationKeyRequest.newBuilder()
           .setName(
               HcxActivationKeyName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[HCX_ACTIVATION_KEY]")
                   .toString())
           .build();
   HcxActivationKey response = vmwareEngineClient.getHcxActivationKey(request);
 }
 
Parameter
Name Description
request GetHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
HcxActivationKey

getHcxActivationKey(HcxActivationKeyName name)

public final HcxActivationKey getHcxActivationKey(HcxActivationKeyName name)

Retrieves a HcxActivationKey resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   HcxActivationKeyName name =
       HcxActivationKeyName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[HCX_ACTIVATION_KEY]");
   HcxActivationKey response = vmwareEngineClient.getHcxActivationKey(name);
 }
 
Parameter
Name Description
name HcxActivationKeyName

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

Returns
Type Description
HcxActivationKey

getHcxActivationKey(String name)

public final HcxActivationKey getHcxActivationKey(String name)

Retrieves a HcxActivationKey resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       HcxActivationKeyName.of(
               "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[HCX_ACTIVATION_KEY]")
           .toString();
   HcxActivationKey response = vmwareEngineClient.getHcxActivationKey(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
HcxActivationKey

getHcxActivationKeyCallable()

public final UnaryCallable<GetHcxActivationKeyRequest,HcxActivationKey> getHcxActivationKeyCallable()

Retrieves a HcxActivationKey resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetHcxActivationKeyRequest request =
       GetHcxActivationKeyRequest.newBuilder()
           .setName(
               HcxActivationKeyName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[HCX_ACTIVATION_KEY]")
                   .toString())
           .build();
   ApiFuture<HcxActivationKey> future =
       vmwareEngineClient.getHcxActivationKeyCallable().futureCall(request);
   // Do something.
   HcxActivationKey response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetHcxActivationKeyRequest,HcxActivationKey>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = vmwareEngineClient.getIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = vmwareEngineClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = vmwareEngineClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = vmwareEngineClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getLoggingServer(GetLoggingServerRequest request)

public final LoggingServer getLoggingServer(GetLoggingServerRequest request)

Gets details of a logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetLoggingServerRequest request =
       GetLoggingServerRequest.newBuilder()
           .setName(
               LoggingServerName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
                   .toString())
           .build();
   LoggingServer response = vmwareEngineClient.getLoggingServer(request);
 }
 
Parameter
Name Description
request GetLoggingServerRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
LoggingServer

getLoggingServer(LoggingServerName name)

public final LoggingServer getLoggingServer(LoggingServerName name)

Gets details of a logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LoggingServerName name =
       LoggingServerName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]");
   LoggingServer response = vmwareEngineClient.getLoggingServer(name);
 }
 
Parameter
Name Description
name LoggingServerName

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

Returns
Type Description
LoggingServer

getLoggingServer(String name)

public final LoggingServer getLoggingServer(String name)

Gets details of a logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       LoggingServerName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
           .toString();
   LoggingServer response = vmwareEngineClient.getLoggingServer(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
LoggingServer

getLoggingServerCallable()

public final UnaryCallable<GetLoggingServerRequest,LoggingServer> getLoggingServerCallable()

Gets details of a logging server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetLoggingServerRequest request =
       GetLoggingServerRequest.newBuilder()
           .setName(
               LoggingServerName.of(
                       "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[LOGGING_SERVER]")
                   .toString())
           .build();
   ApiFuture<LoggingServer> future =
       vmwareEngineClient.getLoggingServerCallable().futureCall(request);
   // Do something.
   LoggingServer response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetLoggingServerRequest,LoggingServer>

getManagementDnsZoneBinding(GetManagementDnsZoneBindingRequest request)

public final ManagementDnsZoneBinding getManagementDnsZoneBinding(GetManagementDnsZoneBindingRequest request)

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetManagementDnsZoneBindingRequest request =
       GetManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .build();
   ManagementDnsZoneBinding response = vmwareEngineClient.getManagementDnsZoneBinding(request);
 }
 
Parameter
Name Description
request GetManagementDnsZoneBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ManagementDnsZoneBinding

getManagementDnsZoneBinding(ManagementDnsZoneBindingName name)

public final ManagementDnsZoneBinding getManagementDnsZoneBinding(ManagementDnsZoneBindingName name)

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ManagementDnsZoneBindingName name =
       ManagementDnsZoneBindingName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]");
   ManagementDnsZoneBinding response = vmwareEngineClient.getManagementDnsZoneBinding(name);
 }
 
Parameter
Name Description
name ManagementDnsZoneBindingName

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

Returns
Type Description
ManagementDnsZoneBinding

getManagementDnsZoneBinding(String name)

public final ManagementDnsZoneBinding getManagementDnsZoneBinding(String name)

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ManagementDnsZoneBindingName.of(
               "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]")
           .toString();
   ManagementDnsZoneBinding response = vmwareEngineClient.getManagementDnsZoneBinding(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
ManagementDnsZoneBinding

getManagementDnsZoneBindingCallable()

public final UnaryCallable<GetManagementDnsZoneBindingRequest,ManagementDnsZoneBinding> getManagementDnsZoneBindingCallable()

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetManagementDnsZoneBindingRequest request =
       GetManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .build();
   ApiFuture<ManagementDnsZoneBinding> future =
       vmwareEngineClient.getManagementDnsZoneBindingCallable().futureCall(request);
   // Do something.
   ManagementDnsZoneBinding response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetManagementDnsZoneBindingRequest,ManagementDnsZoneBinding>

getNetworkPeering(GetNetworkPeeringRequest request)

public final NetworkPeering getNetworkPeering(GetNetworkPeeringRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNetworkPeeringRequest request =
       GetNetworkPeeringRequest.newBuilder()
           .setName(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .build();
   NetworkPeering response = vmwareEngineClient.getNetworkPeering(request);
 }
 
Parameter
Name Description
request GetNetworkPeeringRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetworkPeering

getNetworkPeering(NetworkPeeringName name)

public final NetworkPeering getNetworkPeering(NetworkPeeringName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPeeringName name =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]");
   NetworkPeering response = vmwareEngineClient.getNetworkPeering(name);
 }
 
Parameter
Name Description
name NetworkPeeringName

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

Returns
Type Description
NetworkPeering

getNetworkPeering(String name)

public final NetworkPeering getNetworkPeering(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString();
   NetworkPeering response = vmwareEngineClient.getNetworkPeering(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
NetworkPeering

getNetworkPeeringCallable()

public final UnaryCallable<GetNetworkPeeringRequest,NetworkPeering> getNetworkPeeringCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNetworkPeeringRequest request =
       GetNetworkPeeringRequest.newBuilder()
           .setName(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .build();
   ApiFuture<NetworkPeering> future =
       vmwareEngineClient.getNetworkPeeringCallable().futureCall(request);
   // Do something.
   NetworkPeering response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNetworkPeeringRequest,NetworkPeering>

getNetworkPolicy(GetNetworkPolicyRequest request)

public final NetworkPolicy getNetworkPolicy(GetNetworkPolicyRequest request)

Retrieves a NetworkPolicy resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNetworkPolicyRequest request =
       GetNetworkPolicyRequest.newBuilder()
           .setName(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .build();
   NetworkPolicy response = vmwareEngineClient.getNetworkPolicy(request);
 }
 
Parameter
Name Description
request GetNetworkPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NetworkPolicy

getNetworkPolicy(NetworkPolicyName name)

public final NetworkPolicy getNetworkPolicy(NetworkPolicyName name)

Retrieves a NetworkPolicy resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicyName name = NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]");
   NetworkPolicy response = vmwareEngineClient.getNetworkPolicy(name);
 }
 
Parameter
Name Description
name NetworkPolicyName

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

Returns
Type Description
NetworkPolicy

getNetworkPolicy(String name)

public final NetworkPolicy getNetworkPolicy(String name)

Retrieves a NetworkPolicy resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString();
   NetworkPolicy response = vmwareEngineClient.getNetworkPolicy(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
NetworkPolicy

getNetworkPolicyCallable()

public final UnaryCallable<GetNetworkPolicyRequest,NetworkPolicy> getNetworkPolicyCallable()

Retrieves a NetworkPolicy resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNetworkPolicyRequest request =
       GetNetworkPolicyRequest.newBuilder()
           .setName(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .build();
   ApiFuture<NetworkPolicy> future =
       vmwareEngineClient.getNetworkPolicyCallable().futureCall(request);
   // Do something.
   NetworkPolicy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNetworkPolicyRequest,NetworkPolicy>

getNode(GetNodeRequest request)

public final Node getNode(GetNodeRequest request)

Gets details of a single node.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNodeRequest request =
       GetNodeRequest.newBuilder()
           .setName(
               NodeName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]", "[NODE]")
                   .toString())
           .build();
   Node response = vmwareEngineClient.getNode(request);
 }
 
Parameter
Name Description
request GetNodeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Node

getNode(NodeName name)

public final Node getNode(NodeName name)

Gets details of a single node.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NodeName name =
       NodeName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]", "[NODE]");
   Node response = vmwareEngineClient.getNode(name);
 }
 
Parameter
Name Description
name NodeName

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

Returns
Type Description
Node

getNode(String name)

public final Node getNode(String name)

Gets details of a single node.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       NodeName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]", "[NODE]")
           .toString();
   Node response = vmwareEngineClient.getNode(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
Node

getNodeCallable()

public final UnaryCallable<GetNodeRequest,Node> getNodeCallable()

Gets details of a single node.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNodeRequest request =
       GetNodeRequest.newBuilder()
           .setName(
               NodeName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]", "[NODE]")
                   .toString())
           .build();
   ApiFuture<Node> future = vmwareEngineClient.getNodeCallable().futureCall(request);
   // Do something.
   Node response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNodeRequest,Node>

getNodeType(GetNodeTypeRequest request)

public final NodeType getNodeType(GetNodeTypeRequest request)

Gets details of a single NodeType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNodeTypeRequest request =
       GetNodeTypeRequest.newBuilder()
           .setName(NodeTypeName.of("[PROJECT]", "[LOCATION]", "[NODE_TYPE]").toString())
           .build();
   NodeType response = vmwareEngineClient.getNodeType(request);
 }
 
Parameter
Name Description
request GetNodeTypeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NodeType

getNodeType(NodeTypeName name)

public final NodeType getNodeType(NodeTypeName name)

Gets details of a single NodeType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NodeTypeName name = NodeTypeName.of("[PROJECT]", "[LOCATION]", "[NODE_TYPE]");
   NodeType response = vmwareEngineClient.getNodeType(name);
 }
 
Parameter
Name Description
name NodeTypeName

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

Returns
Type Description
NodeType

getNodeType(String name)

public final NodeType getNodeType(String name)

Gets details of a single NodeType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = NodeTypeName.of("[PROJECT]", "[LOCATION]", "[NODE_TYPE]").toString();
   NodeType response = vmwareEngineClient.getNodeType(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
NodeType

getNodeTypeCallable()

public final UnaryCallable<GetNodeTypeRequest,NodeType> getNodeTypeCallable()

Gets details of a single NodeType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetNodeTypeRequest request =
       GetNodeTypeRequest.newBuilder()
           .setName(NodeTypeName.of("[PROJECT]", "[LOCATION]", "[NODE_TYPE]").toString())
           .build();
   ApiFuture<NodeType> future = vmwareEngineClient.getNodeTypeCallable().futureCall(request);
   // Do something.
   NodeType response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNodeTypeRequest,NodeType>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getPrivateCloud(GetPrivateCloudRequest request)

public final PrivateCloud getPrivateCloud(GetPrivateCloudRequest request)

Retrieves a PrivateCloud resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetPrivateCloudRequest request =
       GetPrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   PrivateCloud response = vmwareEngineClient.getPrivateCloud(request);
 }
 
Parameter
Name Description
request GetPrivateCloudRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PrivateCloud

getPrivateCloud(PrivateCloudName name)

public final PrivateCloud getPrivateCloud(PrivateCloudName name)

Retrieves a PrivateCloud resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.getPrivateCloud(name);
 }
 
Parameter
Name Description
name PrivateCloudName

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

Returns
Type Description
PrivateCloud

getPrivateCloud(String name)

public final PrivateCloud getPrivateCloud(String name)

Retrieves a PrivateCloud resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   PrivateCloud response = vmwareEngineClient.getPrivateCloud(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
PrivateCloud

getPrivateCloudCallable()

public final UnaryCallable<GetPrivateCloudRequest,PrivateCloud> getPrivateCloudCallable()

Retrieves a PrivateCloud resource by its resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetPrivateCloudRequest request =
       GetPrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   ApiFuture<PrivateCloud> future =
       vmwareEngineClient.getPrivateCloudCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetPrivateCloudRequest,PrivateCloud>

getPrivateConnection(GetPrivateConnectionRequest request)

public final PrivateConnection getPrivateConnection(GetPrivateConnectionRequest request)

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetPrivateConnectionRequest request =
       GetPrivateConnectionRequest.newBuilder()
           .setName(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .build();
   PrivateConnection response = vmwareEngineClient.getPrivateConnection(request);
 }
 
Parameter
Name Description
request GetPrivateConnectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PrivateConnection

getPrivateConnection(PrivateConnectionName name)

public final PrivateConnection getPrivateConnection(PrivateConnectionName name)

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateConnectionName name =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]");
   PrivateConnection response = vmwareEngineClient.getPrivateConnection(name);
 }
 
Parameter
Name Description
name PrivateConnectionName

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

Returns
Type Description
PrivateConnection

getPrivateConnection(String name)

public final PrivateConnection getPrivateConnection(String name)

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]").toString();
   PrivateConnection response = vmwareEngineClient.getPrivateConnection(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
PrivateConnection

getPrivateConnectionCallable()

public final UnaryCallable<GetPrivateConnectionRequest,PrivateConnection> getPrivateConnectionCallable()

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetPrivateConnectionRequest request =
       GetPrivateConnectionRequest.newBuilder()
           .setName(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .build();
   ApiFuture<PrivateConnection> future =
       vmwareEngineClient.getPrivateConnectionCallable().futureCall(request);
   // Do something.
   PrivateConnection response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetPrivateConnectionRequest,PrivateConnection>

getSettings()

public final VmwareEngineSettings getSettings()
Returns
Type Description
VmwareEngineSettings

getStub()

public VmwareEngineStub getStub()
Returns
Type Description
VmwareEngineStub

getSubnet(GetSubnetRequest request)

public final Subnet getSubnet(GetSubnetRequest request)

Gets details of a single subnet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetSubnetRequest request =
       GetSubnetRequest.newBuilder()
           .setName(
               SubnetName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[SUBNET]")
                   .toString())
           .build();
   Subnet response = vmwareEngineClient.getSubnet(request);
 }
 
Parameter
Name Description
request GetSubnetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Subnet

getSubnet(SubnetName name)

public final Subnet getSubnet(SubnetName name)

Gets details of a single subnet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   SubnetName name = SubnetName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[SUBNET]");
   Subnet response = vmwareEngineClient.getSubnet(name);
 }
 
Parameter
Name Description
name SubnetName

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

Returns
Type Description
Subnet

getSubnet(String name)

public final Subnet getSubnet(String name)

Gets details of a single subnet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       SubnetName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[SUBNET]").toString();
   Subnet response = vmwareEngineClient.getSubnet(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
Subnet

getSubnetCallable()

public final UnaryCallable<GetSubnetRequest,Subnet> getSubnetCallable()

Gets details of a single subnet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetSubnetRequest request =
       GetSubnetRequest.newBuilder()
           .setName(
               SubnetName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[SUBNET]")
                   .toString())
           .build();
   ApiFuture<Subnet> future = vmwareEngineClient.getSubnetCallable().futureCall(request);
   // Do something.
   Subnet response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSubnetRequest,Subnet>

getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request)

public final VmwareEngineNetwork getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetVmwareEngineNetworkRequest request =
       GetVmwareEngineNetworkRequest.newBuilder()
           .setName(
               VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
                   .toString())
           .build();
   VmwareEngineNetwork response = vmwareEngineClient.getVmwareEngineNetwork(request);
 }
 
Parameter
Name Description
request GetVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineNetwork

getVmwareEngineNetwork(VmwareEngineNetworkName name)

public final VmwareEngineNetwork getVmwareEngineNetwork(VmwareEngineNetworkName name)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   VmwareEngineNetworkName name =
       VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]");
   VmwareEngineNetwork response = vmwareEngineClient.getVmwareEngineNetwork(name);
 }
 
Parameter
Name Description
name VmwareEngineNetworkName

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

Returns
Type Description
VmwareEngineNetwork

getVmwareEngineNetwork(String name)

public final VmwareEngineNetwork getVmwareEngineNetwork(String name)

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
           .toString();
   VmwareEngineNetwork response = vmwareEngineClient.getVmwareEngineNetwork(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
VmwareEngineNetwork

getVmwareEngineNetworkCallable()

public final UnaryCallable<GetVmwareEngineNetworkRequest,VmwareEngineNetwork> getVmwareEngineNetworkCallable()

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).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GetVmwareEngineNetworkRequest request =
       GetVmwareEngineNetworkRequest.newBuilder()
           .setName(
               VmwareEngineNetworkName.of("[PROJECT]", "[LOCATION]", "[VMWARE_ENGINE_NETWORK]")
                   .toString())
           .build();
   ApiFuture<VmwareEngineNetwork> future =
       vmwareEngineClient.getVmwareEngineNetworkCallable().futureCall(request);
   // Do something.
   VmwareEngineNetwork response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetVmwareEngineNetworkRequest,VmwareEngineNetwork>

grantDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

public final OperationFuture<DnsBindPermission,OperationMetadata> grantDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DnsBindPermissionName name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]");
   Principal principal = Principal.newBuilder().build();
   DnsBindPermission response =
       vmwareEngineClient.grantDnsBindPermissionAsync(name, principal).get();
 }
 
Parameters
Name Description
name DnsBindPermissionName

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 Principal

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

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

grantDnsBindPermissionAsync(GrantDnsBindPermissionRequest request)

public final OperationFuture<DnsBindPermission,OperationMetadata> grantDnsBindPermissionAsync(GrantDnsBindPermissionRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GrantDnsBindPermissionRequest request =
       GrantDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   DnsBindPermission response = vmwareEngineClient.grantDnsBindPermissionAsync(request).get();
 }
 
Parameter
Name Description
request GrantDnsBindPermissionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

grantDnsBindPermissionAsync(String name, Principal principal)

public final OperationFuture<DnsBindPermission,OperationMetadata> grantDnsBindPermissionAsync(String name, Principal principal)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString();
   Principal principal = Principal.newBuilder().build();
   DnsBindPermission response =
       vmwareEngineClient.grantDnsBindPermissionAsync(name, principal).get();
 }
 
Parameters
Name Description
name String

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 Principal

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

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

grantDnsBindPermissionCallable()

public final UnaryCallable<GrantDnsBindPermissionRequest,Operation> grantDnsBindPermissionCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GrantDnsBindPermissionRequest request =
       GrantDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.grantDnsBindPermissionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GrantDnsBindPermissionRequest,Operation>

grantDnsBindPermissionOperationCallable()

public final OperationCallable<GrantDnsBindPermissionRequest,DnsBindPermission,OperationMetadata> grantDnsBindPermissionOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   GrantDnsBindPermissionRequest request =
       GrantDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<DnsBindPermission, OperationMetadata> future =
       vmwareEngineClient.grantDnsBindPermissionOperationCallable().futureCall(request);
   // Do something.
   DnsBindPermission response = future.get();
 }
 
Returns
Type Description
OperationCallable<GrantDnsBindPermissionRequest,DnsBindPermission,OperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listClusters(ListClustersRequest request)

public final VmwareEngineClient.ListClustersPagedResponse listClusters(ListClustersRequest request)

Lists Cluster resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Cluster element : vmwareEngineClient.listClusters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListClustersPagedResponse

listClusters(PrivateCloudName parent)

public final VmwareEngineClient.ListClustersPagedResponse listClusters(PrivateCloudName parent)

Lists Cluster resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (Cluster element : vmwareEngineClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListClustersPagedResponse

listClusters(String parent)

public final VmwareEngineClient.ListClustersPagedResponse listClusters(String parent)

Lists Cluster resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (Cluster element : vmwareEngineClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListClustersPagedResponse

listClustersCallable()

public final UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()

Lists Cluster resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListClustersResponse response = vmwareEngineClient.listClustersCallable().call(request);
     for (Cluster element : response.getClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListClustersRequest,ListClustersResponse>

listClustersPagedCallable()

public final UnaryCallable<ListClustersRequest,VmwareEngineClient.ListClustersPagedResponse> listClustersPagedCallable()

Lists Cluster resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Cluster> future =
       vmwareEngineClient.listClustersPagedCallable().futureCall(request);
   // Do something.
   for (Cluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListClustersRequest,ListClustersPagedResponse>

listExternalAccessRules(ListExternalAccessRulesRequest request)

public final VmwareEngineClient.ListExternalAccessRulesPagedResponse listExternalAccessRules(ListExternalAccessRulesRequest request)

Lists ExternalAccessRule resources in the specified network policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAccessRulesRequest request =
       ListExternalAccessRulesRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ExternalAccessRule element :
       vmwareEngineClient.listExternalAccessRules(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListExternalAccessRulesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListExternalAccessRulesPagedResponse

listExternalAccessRules(NetworkPolicyName parent)

public final VmwareEngineClient.ListExternalAccessRulesPagedResponse listExternalAccessRules(NetworkPolicyName parent)

Lists ExternalAccessRule resources in the specified network policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicyName parent =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]");
   for (ExternalAccessRule element :
       vmwareEngineClient.listExternalAccessRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent NetworkPolicyName

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

Returns
Type Description
VmwareEngineClient.ListExternalAccessRulesPagedResponse

listExternalAccessRules(String parent)

public final VmwareEngineClient.ListExternalAccessRulesPagedResponse listExternalAccessRules(String parent)

Lists ExternalAccessRule resources in the specified network policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent =
       NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString();
   for (ExternalAccessRule element :
       vmwareEngineClient.listExternalAccessRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListExternalAccessRulesPagedResponse

listExternalAccessRulesCallable()

public final UnaryCallable<ListExternalAccessRulesRequest,ListExternalAccessRulesResponse> listExternalAccessRulesCallable()

Lists ExternalAccessRule resources in the specified network policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAccessRulesRequest request =
       ListExternalAccessRulesRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListExternalAccessRulesResponse response =
         vmwareEngineClient.listExternalAccessRulesCallable().call(request);
     for (ExternalAccessRule element : response.getExternalAccessRulesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListExternalAccessRulesRequest,ListExternalAccessRulesResponse>

listExternalAccessRulesPagedCallable()

public final UnaryCallable<ListExternalAccessRulesRequest,VmwareEngineClient.ListExternalAccessRulesPagedResponse> listExternalAccessRulesPagedCallable()

Lists ExternalAccessRule resources in the specified network policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAccessRulesRequest request =
       ListExternalAccessRulesRequest.newBuilder()
           .setParent(
               NetworkPolicyName.of("[PROJECT]", "[LOCATION]", "[NETWORK_POLICY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ExternalAccessRule> future =
       vmwareEngineClient.listExternalAccessRulesPagedCallable().futureCall(request);
   // Do something.
   for (ExternalAccessRule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListExternalAccessRulesRequest,ListExternalAccessRulesPagedResponse>

listExternalAddresses(ListExternalAddressesRequest request)

public final VmwareEngineClient.ListExternalAddressesPagedResponse listExternalAddresses(ListExternalAddressesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAddressesRequest request =
       ListExternalAddressesRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ExternalAddress element :
       vmwareEngineClient.listExternalAddresses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListExternalAddressesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListExternalAddressesPagedResponse

listExternalAddresses(PrivateCloudName parent)

public final VmwareEngineClient.ListExternalAddressesPagedResponse listExternalAddresses(PrivateCloudName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (ExternalAddress element :
       vmwareEngineClient.listExternalAddresses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListExternalAddressesPagedResponse

listExternalAddresses(String parent)

public final VmwareEngineClient.ListExternalAddressesPagedResponse listExternalAddresses(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (ExternalAddress element :
       vmwareEngineClient.listExternalAddresses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListExternalAddressesPagedResponse

listExternalAddressesCallable()

public final UnaryCallable<ListExternalAddressesRequest,ListExternalAddressesResponse> listExternalAddressesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAddressesRequest request =
       ListExternalAddressesRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListExternalAddressesResponse response =
         vmwareEngineClient.listExternalAddressesCallable().call(request);
     for (ExternalAddress element : response.getExternalAddressesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListExternalAddressesRequest,ListExternalAddressesResponse>

listExternalAddressesPagedCallable()

public final UnaryCallable<ListExternalAddressesRequest,VmwareEngineClient.ListExternalAddressesPagedResponse> listExternalAddressesPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListExternalAddressesRequest request =
       ListExternalAddressesRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ExternalAddress> future =
       vmwareEngineClient.listExternalAddressesPagedCallable().futureCall(request);
   // Do something.
   for (ExternalAddress element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListExternalAddressesRequest,ListExternalAddressesPagedResponse>

listHcxActivationKeys(ListHcxActivationKeysRequest request)

public final VmwareEngineClient.ListHcxActivationKeysPagedResponse listHcxActivationKeys(ListHcxActivationKeysRequest request)

Lists HcxActivationKey resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListHcxActivationKeysRequest request =
       ListHcxActivationKeysRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (HcxActivationKey element :
       vmwareEngineClient.listHcxActivationKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListHcxActivationKeysRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListHcxActivationKeysPagedResponse

listHcxActivationKeys(PrivateCloudName parent)

public final VmwareEngineClient.ListHcxActivationKeysPagedResponse listHcxActivationKeys(PrivateCloudName parent)

Lists HcxActivationKey resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (HcxActivationKey element :
       vmwareEngineClient.listHcxActivationKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListHcxActivationKeysPagedResponse

listHcxActivationKeys(String parent)

public final VmwareEngineClient.ListHcxActivationKeysPagedResponse listHcxActivationKeys(String parent)

Lists HcxActivationKey resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (HcxActivationKey element :
       vmwareEngineClient.listHcxActivationKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListHcxActivationKeysPagedResponse

listHcxActivationKeysCallable()

public final UnaryCallable<ListHcxActivationKeysRequest,ListHcxActivationKeysResponse> listHcxActivationKeysCallable()

Lists HcxActivationKey resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListHcxActivationKeysRequest request =
       ListHcxActivationKeysRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListHcxActivationKeysResponse response =
         vmwareEngineClient.listHcxActivationKeysCallable().call(request);
     for (HcxActivationKey element : response.getHcxActivationKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListHcxActivationKeysRequest,ListHcxActivationKeysResponse>

listHcxActivationKeysPagedCallable()

public final UnaryCallable<ListHcxActivationKeysRequest,VmwareEngineClient.ListHcxActivationKeysPagedResponse> listHcxActivationKeysPagedCallable()

Lists HcxActivationKey resources in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListHcxActivationKeysRequest request =
       ListHcxActivationKeysRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<HcxActivationKey> future =
       vmwareEngineClient.listHcxActivationKeysPagedCallable().futureCall(request);
   // Do something.
   for (HcxActivationKey element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListHcxActivationKeysRequest,ListHcxActivationKeysPagedResponse>

listLocations(ListLocationsRequest request)

public final VmwareEngineClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : vmwareEngineClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = vmwareEngineClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,VmwareEngineClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       vmwareEngineClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listLoggingServers(ListLoggingServersRequest request)

public final VmwareEngineClient.ListLoggingServersPagedResponse listLoggingServers(ListLoggingServersRequest request)

Lists logging servers configured for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLoggingServersRequest request =
       ListLoggingServersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (LoggingServer element : vmwareEngineClient.listLoggingServers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListLoggingServersRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListLoggingServersPagedResponse

listLoggingServers(PrivateCloudName parent)

public final VmwareEngineClient.ListLoggingServersPagedResponse listLoggingServers(PrivateCloudName parent)

Lists logging servers configured for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (LoggingServer element : vmwareEngineClient.listLoggingServers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListLoggingServersPagedResponse

listLoggingServers(String parent)

public final VmwareEngineClient.ListLoggingServersPagedResponse listLoggingServers(String parent)

Lists logging servers configured for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (LoggingServer element : vmwareEngineClient.listLoggingServers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListLoggingServersPagedResponse

listLoggingServersCallable()

public final UnaryCallable<ListLoggingServersRequest,ListLoggingServersResponse> listLoggingServersCallable()

Lists logging servers configured for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLoggingServersRequest request =
       ListLoggingServersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListLoggingServersResponse response =
         vmwareEngineClient.listLoggingServersCallable().call(request);
     for (LoggingServer element : response.getLoggingServersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListLoggingServersRequest,ListLoggingServersResponse>

listLoggingServersPagedCallable()

public final UnaryCallable<ListLoggingServersRequest,VmwareEngineClient.ListLoggingServersPagedResponse> listLoggingServersPagedCallable()

Lists logging servers configured for a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListLoggingServersRequest request =
       ListLoggingServersRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<LoggingServer> future =
       vmwareEngineClient.listLoggingServersPagedCallable().futureCall(request);
   // Do something.
   for (LoggingServer element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListLoggingServersRequest,ListLoggingServersPagedResponse>

listManagementDnsZoneBindings(ListManagementDnsZoneBindingsRequest request)

public final VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse listManagementDnsZoneBindings(ListManagementDnsZoneBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListManagementDnsZoneBindingsRequest request =
       ListManagementDnsZoneBindingsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ManagementDnsZoneBinding element :
       vmwareEngineClient.listManagementDnsZoneBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListManagementDnsZoneBindingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse

listManagementDnsZoneBindings(PrivateCloudName parent)

public final VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse listManagementDnsZoneBindings(PrivateCloudName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (ManagementDnsZoneBinding element :
       vmwareEngineClient.listManagementDnsZoneBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse

listManagementDnsZoneBindings(String parent)

public final VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse listManagementDnsZoneBindings(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (ManagementDnsZoneBinding element :
       vmwareEngineClient.listManagementDnsZoneBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse

listManagementDnsZoneBindingsCallable()

public final UnaryCallable<ListManagementDnsZoneBindingsRequest,ListManagementDnsZoneBindingsResponse> listManagementDnsZoneBindingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListManagementDnsZoneBindingsRequest request =
       ListManagementDnsZoneBindingsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListManagementDnsZoneBindingsResponse response =
         vmwareEngineClient.listManagementDnsZoneBindingsCallable().call(request);
     for (ManagementDnsZoneBinding element : response.getManagementDnsZoneBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListManagementDnsZoneBindingsRequest,ListManagementDnsZoneBindingsResponse>

listManagementDnsZoneBindingsPagedCallable()

public final UnaryCallable<ListManagementDnsZoneBindingsRequest,VmwareEngineClient.ListManagementDnsZoneBindingsPagedResponse> listManagementDnsZoneBindingsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListManagementDnsZoneBindingsRequest request =
       ListManagementDnsZoneBindingsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ManagementDnsZoneBinding> future =
       vmwareEngineClient.listManagementDnsZoneBindingsPagedCallable().futureCall(request);
   // Do something.
   for (ManagementDnsZoneBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListManagementDnsZoneBindingsRequest,ListManagementDnsZoneBindingsPagedResponse>

listNetworkPeerings(ListNetworkPeeringsRequest request)

public final VmwareEngineClient.ListNetworkPeeringsPagedResponse listNetworkPeerings(ListNetworkPeeringsRequest request)

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPeeringsRequest request =
       ListNetworkPeeringsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (NetworkPeering element : vmwareEngineClient.listNetworkPeerings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNetworkPeeringsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListNetworkPeeringsPagedResponse

listNetworkPeerings(LocationName parent)

public final VmwareEngineClient.ListNetworkPeeringsPagedResponse listNetworkPeerings(LocationName parent)

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NetworkPeering element : vmwareEngineClient.listNetworkPeerings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListNetworkPeeringsPagedResponse

listNetworkPeerings(String parent)

public final VmwareEngineClient.ListNetworkPeeringsPagedResponse listNetworkPeerings(String parent)

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NetworkPeering element : vmwareEngineClient.listNetworkPeerings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListNetworkPeeringsPagedResponse

listNetworkPeeringsCallable()

public final UnaryCallable<ListNetworkPeeringsRequest,ListNetworkPeeringsResponse> listNetworkPeeringsCallable()

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPeeringsRequest request =
       ListNetworkPeeringsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListNetworkPeeringsResponse response =
         vmwareEngineClient.listNetworkPeeringsCallable().call(request);
     for (NetworkPeering element : response.getNetworkPeeringsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworkPeeringsRequest,ListNetworkPeeringsResponse>

listNetworkPeeringsPagedCallable()

public final UnaryCallable<ListNetworkPeeringsRequest,VmwareEngineClient.ListNetworkPeeringsPagedResponse> listNetworkPeeringsPagedCallable()

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPeeringsRequest request =
       ListNetworkPeeringsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<NetworkPeering> future =
       vmwareEngineClient.listNetworkPeeringsPagedCallable().futureCall(request);
   // Do something.
   for (NetworkPeering element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworkPeeringsRequest,ListNetworkPeeringsPagedResponse>

listNetworkPolicies(ListNetworkPoliciesRequest request)

public final VmwareEngineClient.ListNetworkPoliciesPagedResponse listNetworkPolicies(ListNetworkPoliciesRequest request)

Lists NetworkPolicy resources in a specified project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPoliciesRequest request =
       ListNetworkPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (NetworkPolicy element : vmwareEngineClient.listNetworkPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNetworkPoliciesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListNetworkPoliciesPagedResponse

listNetworkPolicies(LocationName parent)

public final VmwareEngineClient.ListNetworkPoliciesPagedResponse listNetworkPolicies(LocationName parent)

Lists NetworkPolicy resources in a specified project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NetworkPolicy element : vmwareEngineClient.listNetworkPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListNetworkPoliciesPagedResponse

listNetworkPolicies(String parent)

public final VmwareEngineClient.ListNetworkPoliciesPagedResponse listNetworkPolicies(String parent)

Lists NetworkPolicy resources in a specified project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NetworkPolicy element : vmwareEngineClient.listNetworkPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListNetworkPoliciesPagedResponse

listNetworkPoliciesCallable()

public final UnaryCallable<ListNetworkPoliciesRequest,ListNetworkPoliciesResponse> listNetworkPoliciesCallable()

Lists NetworkPolicy resources in a specified project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPoliciesRequest request =
       ListNetworkPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListNetworkPoliciesResponse response =
         vmwareEngineClient.listNetworkPoliciesCallable().call(request);
     for (NetworkPolicy element : response.getNetworkPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworkPoliciesRequest,ListNetworkPoliciesResponse>

listNetworkPoliciesPagedCallable()

public final UnaryCallable<ListNetworkPoliciesRequest,VmwareEngineClient.ListNetworkPoliciesPagedResponse> listNetworkPoliciesPagedCallable()

Lists NetworkPolicy resources in a specified project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNetworkPoliciesRequest request =
       ListNetworkPoliciesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<NetworkPolicy> future =
       vmwareEngineClient.listNetworkPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (NetworkPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworkPoliciesRequest,ListNetworkPoliciesPagedResponse>

listNodeTypes(ListNodeTypesRequest request)

public final VmwareEngineClient.ListNodeTypesPagedResponse listNodeTypes(ListNodeTypesRequest request)

Lists node types

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodeTypesRequest request =
       ListNodeTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (NodeType element : vmwareEngineClient.listNodeTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNodeTypesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListNodeTypesPagedResponse

listNodeTypes(LocationName parent)

public final VmwareEngineClient.ListNodeTypesPagedResponse listNodeTypes(LocationName parent)

Lists node types

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NodeType element : vmwareEngineClient.listNodeTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListNodeTypesPagedResponse

listNodeTypes(String parent)

public final VmwareEngineClient.ListNodeTypesPagedResponse listNodeTypes(String parent)

Lists node types

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NodeType element : vmwareEngineClient.listNodeTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListNodeTypesPagedResponse

listNodeTypesCallable()

public final UnaryCallable<ListNodeTypesRequest,ListNodeTypesResponse> listNodeTypesCallable()

Lists node types

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodeTypesRequest request =
       ListNodeTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListNodeTypesResponse response = vmwareEngineClient.listNodeTypesCallable().call(request);
     for (NodeType element : response.getNodeTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNodeTypesRequest,ListNodeTypesResponse>

listNodeTypesPagedCallable()

public final UnaryCallable<ListNodeTypesRequest,VmwareEngineClient.ListNodeTypesPagedResponse> listNodeTypesPagedCallable()

Lists node types

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodeTypesRequest request =
       ListNodeTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<NodeType> future =
       vmwareEngineClient.listNodeTypesPagedCallable().futureCall(request);
   // Do something.
   for (NodeType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNodeTypesRequest,ListNodeTypesPagedResponse>

listNodes(ClusterName parent)

public final VmwareEngineClient.ListNodesPagedResponse listNodes(ClusterName parent)

Lists nodes in a given cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ClusterName parent =
       ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]");
   for (Node element : vmwareEngineClient.listNodes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent ClusterName

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

Returns
Type Description
VmwareEngineClient.ListNodesPagedResponse

listNodes(ListNodesRequest request)

public final VmwareEngineClient.ListNodesPagedResponse listNodes(ListNodesRequest request)

Lists nodes in a given cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodesRequest request =
       ListNodesRequest.newBuilder()
           .setParent(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Node element : vmwareEngineClient.listNodes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNodesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListNodesPagedResponse

listNodes(String parent)

public final VmwareEngineClient.ListNodesPagedResponse listNodes(String parent)

Lists nodes in a given cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent =
       ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]").toString();
   for (Node element : vmwareEngineClient.listNodes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListNodesPagedResponse

listNodesCallable()

public final UnaryCallable<ListNodesRequest,ListNodesResponse> listNodesCallable()

Lists nodes in a given cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodesRequest request =
       ListNodesRequest.newBuilder()
           .setParent(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListNodesResponse response = vmwareEngineClient.listNodesCallable().call(request);
     for (Node element : response.getNodesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNodesRequest,ListNodesResponse>

listNodesPagedCallable()

public final UnaryCallable<ListNodesRequest,VmwareEngineClient.ListNodesPagedResponse> listNodesPagedCallable()

Lists nodes in a given cluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListNodesRequest request =
       ListNodesRequest.newBuilder()
           .setParent(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Node> future = vmwareEngineClient.listNodesPagedCallable().futureCall(request);
   // Do something.
   for (Node element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNodesRequest,ListNodesPagedResponse>

listPeeringRoutes(ListPeeringRoutesRequest request)

public final VmwareEngineClient.ListPeeringRoutesPagedResponse listPeeringRoutes(ListPeeringRoutesRequest request)

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPeeringRoutesRequest request =
       ListPeeringRoutesRequest.newBuilder()
           .setParent(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (PeeringRoute element : vmwareEngineClient.listPeeringRoutes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPeeringRoutesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListPeeringRoutesPagedResponse

listPeeringRoutes(NetworkPeeringName parent)

public final VmwareEngineClient.ListPeeringRoutesPagedResponse listPeeringRoutes(NetworkPeeringName parent)

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPeeringName parent =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]");
   for (PeeringRoute element : vmwareEngineClient.listPeeringRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent NetworkPeeringName

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

Returns
Type Description
VmwareEngineClient.ListPeeringRoutesPagedResponse

listPeeringRoutes(String parent)

public final VmwareEngineClient.ListPeeringRoutesPagedResponse listPeeringRoutes(String parent)

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent =
       NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString();
   for (PeeringRoute element : vmwareEngineClient.listPeeringRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListPeeringRoutesPagedResponse

listPeeringRoutesCallable()

public final UnaryCallable<ListPeeringRoutesRequest,ListPeeringRoutesResponse> listPeeringRoutesCallable()

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPeeringRoutesRequest request =
       ListPeeringRoutesRequest.newBuilder()
           .setParent(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListPeeringRoutesResponse response =
         vmwareEngineClient.listPeeringRoutesCallable().call(request);
     for (PeeringRoute element : response.getPeeringRoutesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPeeringRoutesRequest,ListPeeringRoutesResponse>

listPeeringRoutesPagedCallable()

public final UnaryCallable<ListPeeringRoutesRequest,VmwareEngineClient.ListPeeringRoutesPagedResponse> listPeeringRoutesPagedCallable()

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPeeringRoutesRequest request =
       ListPeeringRoutesRequest.newBuilder()
           .setParent(
               NetworkPeeringName.of("[PROJECT]", "[LOCATION]", "[NETWORK_PEERING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<PeeringRoute> future =
       vmwareEngineClient.listPeeringRoutesPagedCallable().futureCall(request);
   // Do something.
   for (PeeringRoute element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPeeringRoutesRequest,ListPeeringRoutesPagedResponse>

listPrivateClouds(ListPrivateCloudsRequest request)

public final VmwareEngineClient.ListPrivateCloudsPagedResponse listPrivateClouds(ListPrivateCloudsRequest request)

Lists PrivateCloud resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateCloudsRequest request =
       ListPrivateCloudsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (PrivateCloud element : vmwareEngineClient.listPrivateClouds(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPrivateCloudsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListPrivateCloudsPagedResponse

listPrivateClouds(LocationName parent)

public final VmwareEngineClient.ListPrivateCloudsPagedResponse listPrivateClouds(LocationName parent)

Lists PrivateCloud resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PrivateCloud element : vmwareEngineClient.listPrivateClouds(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListPrivateCloudsPagedResponse

listPrivateClouds(String parent)

public final VmwareEngineClient.ListPrivateCloudsPagedResponse listPrivateClouds(String parent)

Lists PrivateCloud resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (PrivateCloud element : vmwareEngineClient.listPrivateClouds(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListPrivateCloudsPagedResponse

listPrivateCloudsCallable()

public final UnaryCallable<ListPrivateCloudsRequest,ListPrivateCloudsResponse> listPrivateCloudsCallable()

Lists PrivateCloud resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateCloudsRequest request =
       ListPrivateCloudsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListPrivateCloudsResponse response =
         vmwareEngineClient.listPrivateCloudsCallable().call(request);
     for (PrivateCloud element : response.getPrivateCloudsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateCloudsRequest,ListPrivateCloudsResponse>

listPrivateCloudsPagedCallable()

public final UnaryCallable<ListPrivateCloudsRequest,VmwareEngineClient.ListPrivateCloudsPagedResponse> listPrivateCloudsPagedCallable()

Lists PrivateCloud resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateCloudsRequest request =
       ListPrivateCloudsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<PrivateCloud> future =
       vmwareEngineClient.listPrivateCloudsPagedCallable().futureCall(request);
   // Do something.
   for (PrivateCloud element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateCloudsRequest,ListPrivateCloudsPagedResponse>

listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request)

public final VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request)

Lists the private connection routes exchanged over a peering connection.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionPeeringRoutesRequest request =
       ListPrivateConnectionPeeringRoutesRequest.newBuilder()
           .setParent(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PeeringRoute element :
       vmwareEngineClient.listPrivateConnectionPeeringRoutes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPrivateConnectionPeeringRoutesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse

listPrivateConnectionPeeringRoutes(PrivateConnectionName parent)

public final VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse listPrivateConnectionPeeringRoutes(PrivateConnectionName parent)

Lists the private connection routes exchanged over a peering connection.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateConnectionName parent =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]");
   for (PeeringRoute element :
       vmwareEngineClient.listPrivateConnectionPeeringRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateConnectionName

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

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse

listPrivateConnectionPeeringRoutes(String parent)

public final VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse listPrivateConnectionPeeringRoutes(String parent)

Lists the private connection routes exchanged over a peering connection.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent =
       PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]").toString();
   for (PeeringRoute element :
       vmwareEngineClient.listPrivateConnectionPeeringRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse

listPrivateConnectionPeeringRoutesCallable()

public final UnaryCallable<ListPrivateConnectionPeeringRoutesRequest,ListPrivateConnectionPeeringRoutesResponse> listPrivateConnectionPeeringRoutesCallable()

Lists the private connection routes exchanged over a peering connection.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionPeeringRoutesRequest request =
       ListPrivateConnectionPeeringRoutesRequest.newBuilder()
           .setParent(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPrivateConnectionPeeringRoutesResponse response =
         vmwareEngineClient.listPrivateConnectionPeeringRoutesCallable().call(request);
     for (PeeringRoute element : response.getPeeringRoutesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateConnectionPeeringRoutesRequest,ListPrivateConnectionPeeringRoutesResponse>

listPrivateConnectionPeeringRoutesPagedCallable()

public final UnaryCallable<ListPrivateConnectionPeeringRoutesRequest,VmwareEngineClient.ListPrivateConnectionPeeringRoutesPagedResponse> listPrivateConnectionPeeringRoutesPagedCallable()

Lists the private connection routes exchanged over a peering connection.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionPeeringRoutesRequest request =
       ListPrivateConnectionPeeringRoutesRequest.newBuilder()
           .setParent(
               PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PeeringRoute> future =
       vmwareEngineClient.listPrivateConnectionPeeringRoutesPagedCallable().futureCall(request);
   // Do something.
   for (PeeringRoute element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateConnectionPeeringRoutesRequest,ListPrivateConnectionPeeringRoutesPagedResponse>

listPrivateConnections(ListPrivateConnectionsRequest request)

public final VmwareEngineClient.ListPrivateConnectionsPagedResponse listPrivateConnections(ListPrivateConnectionsRequest request)

Lists PrivateConnection resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionsRequest request =
       ListPrivateConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (PrivateConnection element :
       vmwareEngineClient.listPrivateConnections(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPrivateConnectionsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionsPagedResponse

listPrivateConnections(LocationName parent)

public final VmwareEngineClient.ListPrivateConnectionsPagedResponse listPrivateConnections(LocationName parent)

Lists PrivateConnection resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PrivateConnection element :
       vmwareEngineClient.listPrivateConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionsPagedResponse

listPrivateConnections(String parent)

public final VmwareEngineClient.ListPrivateConnectionsPagedResponse listPrivateConnections(String parent)

Lists PrivateConnection resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (PrivateConnection element :
       vmwareEngineClient.listPrivateConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListPrivateConnectionsPagedResponse

listPrivateConnectionsCallable()

public final UnaryCallable<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse> listPrivateConnectionsCallable()

Lists PrivateConnection resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionsRequest request =
       ListPrivateConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListPrivateConnectionsResponse response =
         vmwareEngineClient.listPrivateConnectionsCallable().call(request);
     for (PrivateConnection element : response.getPrivateConnectionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse>

listPrivateConnectionsPagedCallable()

public final UnaryCallable<ListPrivateConnectionsRequest,VmwareEngineClient.ListPrivateConnectionsPagedResponse> listPrivateConnectionsPagedCallable()

Lists PrivateConnection resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListPrivateConnectionsRequest request =
       ListPrivateConnectionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<PrivateConnection> future =
       vmwareEngineClient.listPrivateConnectionsPagedCallable().futureCall(request);
   // Do something.
   for (PrivateConnection element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPrivateConnectionsRequest,ListPrivateConnectionsPagedResponse>

listSubnets(ListSubnetsRequest request)

public final VmwareEngineClient.ListSubnetsPagedResponse listSubnets(ListSubnetsRequest request)

Lists subnets in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListSubnetsRequest request =
       ListSubnetsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Subnet element : vmwareEngineClient.listSubnets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSubnetsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListSubnetsPagedResponse

listSubnets(PrivateCloudName parent)

public final VmwareEngineClient.ListSubnetsPagedResponse listSubnets(PrivateCloudName parent)

Lists subnets in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   for (Subnet element : vmwareEngineClient.listSubnets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PrivateCloudName

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

Returns
Type Description
VmwareEngineClient.ListSubnetsPagedResponse

listSubnets(String parent)

public final VmwareEngineClient.ListSubnetsPagedResponse listSubnets(String parent)

Lists subnets in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   for (Subnet element : vmwareEngineClient.listSubnets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListSubnetsPagedResponse

listSubnetsCallable()

public final UnaryCallable<ListSubnetsRequest,ListSubnetsResponse> listSubnetsCallable()

Lists subnets in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListSubnetsRequest request =
       ListSubnetsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSubnetsResponse response = vmwareEngineClient.listSubnetsCallable().call(request);
     for (Subnet element : response.getSubnetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSubnetsRequest,ListSubnetsResponse>

listSubnetsPagedCallable()

public final UnaryCallable<ListSubnetsRequest,VmwareEngineClient.ListSubnetsPagedResponse> listSubnetsPagedCallable()

Lists subnets in a given private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListSubnetsRequest request =
       ListSubnetsRequest.newBuilder()
           .setParent(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Subnet> future = vmwareEngineClient.listSubnetsPagedCallable().futureCall(request);
   // Do something.
   for (Subnet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSubnetsRequest,ListSubnetsPagedResponse>

listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request)

public final VmwareEngineClient.ListVmwareEngineNetworksPagedResponse listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request)

Lists VmwareEngineNetwork resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListVmwareEngineNetworksRequest request =
       ListVmwareEngineNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (VmwareEngineNetwork element :
       vmwareEngineClient.listVmwareEngineNetworks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListVmwareEngineNetworksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VmwareEngineClient.ListVmwareEngineNetworksPagedResponse

listVmwareEngineNetworks(LocationName parent)

public final VmwareEngineClient.ListVmwareEngineNetworksPagedResponse listVmwareEngineNetworks(LocationName parent)

Lists VmwareEngineNetwork resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (VmwareEngineNetwork element :
       vmwareEngineClient.listVmwareEngineNetworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

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

Returns
Type Description
VmwareEngineClient.ListVmwareEngineNetworksPagedResponse

listVmwareEngineNetworks(String parent)

public final VmwareEngineClient.ListVmwareEngineNetworksPagedResponse listVmwareEngineNetworks(String parent)

Lists VmwareEngineNetwork resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (VmwareEngineNetwork element :
       vmwareEngineClient.listVmwareEngineNetworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
VmwareEngineClient.ListVmwareEngineNetworksPagedResponse

listVmwareEngineNetworksCallable()

public final UnaryCallable<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksResponse> listVmwareEngineNetworksCallable()

Lists VmwareEngineNetwork resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListVmwareEngineNetworksRequest request =
       ListVmwareEngineNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVmwareEngineNetworksResponse response =
         vmwareEngineClient.listVmwareEngineNetworksCallable().call(request);
     for (VmwareEngineNetwork element : response.getVmwareEngineNetworksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksResponse>

listVmwareEngineNetworksPagedCallable()

public final UnaryCallable<ListVmwareEngineNetworksRequest,VmwareEngineClient.ListVmwareEngineNetworksPagedResponse> listVmwareEngineNetworksPagedCallable()

Lists VmwareEngineNetwork resources in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ListVmwareEngineNetworksRequest request =
       ListVmwareEngineNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<VmwareEngineNetwork> future =
       vmwareEngineClient.listVmwareEngineNetworksPagedCallable().futureCall(request);
   // Do something.
   for (VmwareEngineNetwork element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksPagedResponse>

repairManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> repairManagementDnsZoneBindingAsync(ManagementDnsZoneBindingName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ManagementDnsZoneBindingName name =
       ManagementDnsZoneBindingName.of(
           "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]");
   ManagementDnsZoneBinding response =
       vmwareEngineClient.repairManagementDnsZoneBindingAsync(name).get();
 }
 
Parameter
Name Description
name ManagementDnsZoneBindingName

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

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

repairManagementDnsZoneBindingAsync(RepairManagementDnsZoneBindingRequest request)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> repairManagementDnsZoneBindingAsync(RepairManagementDnsZoneBindingRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RepairManagementDnsZoneBindingRequest request =
       RepairManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ManagementDnsZoneBinding response =
       vmwareEngineClient.repairManagementDnsZoneBindingAsync(request).get();
 }
 
Parameter
Name Description
request RepairManagementDnsZoneBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

repairManagementDnsZoneBindingAsync(String name)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> repairManagementDnsZoneBindingAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name =
       ManagementDnsZoneBindingName.of(
               "[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[MANAGEMENT_DNS_ZONE_BINDING]")
           .toString();
   ManagementDnsZoneBinding response =
       vmwareEngineClient.repairManagementDnsZoneBindingAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

repairManagementDnsZoneBindingCallable()

public final UnaryCallable<RepairManagementDnsZoneBindingRequest,Operation> repairManagementDnsZoneBindingCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RepairManagementDnsZoneBindingRequest request =
       RepairManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.repairManagementDnsZoneBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RepairManagementDnsZoneBindingRequest,Operation>

repairManagementDnsZoneBindingOperationCallable()

public final OperationCallable<RepairManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata> repairManagementDnsZoneBindingOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RepairManagementDnsZoneBindingRequest request =
       RepairManagementDnsZoneBindingRequest.newBuilder()
           .setName(
               ManagementDnsZoneBindingName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PRIVATE_CLOUD]",
                       "[MANAGEMENT_DNS_ZONE_BINDING]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ManagementDnsZoneBinding, OperationMetadata> future =
       vmwareEngineClient.repairManagementDnsZoneBindingOperationCallable().futureCall(request);
   // Do something.
   ManagementDnsZoneBinding response = future.get();
 }
 
Returns
Type Description
OperationCallable<RepairManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata>

resetNsxCredentialsAsync(PrivateCloudName privateCloud)

public final OperationFuture<PrivateCloud,OperationMetadata> resetNsxCredentialsAsync(PrivateCloudName privateCloud)

Resets credentials of the NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.resetNsxCredentialsAsync(privateCloud).get();
 }
 
Parameter
Name Description
privateCloud PrivateCloudName

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetNsxCredentialsAsync(ResetNsxCredentialsRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> resetNsxCredentialsAsync(ResetNsxCredentialsRequest request)

Resets credentials of the NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetNsxCredentialsRequest request =
       ResetNsxCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   PrivateCloud response = vmwareEngineClient.resetNsxCredentialsAsync(request).get();
 }
 
Parameter
Name Description
request ResetNsxCredentialsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetNsxCredentialsAsync(String privateCloud)

public final OperationFuture<PrivateCloud,OperationMetadata> resetNsxCredentialsAsync(String privateCloud)

Resets credentials of the NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   PrivateCloud response = vmwareEngineClient.resetNsxCredentialsAsync(privateCloud).get();
 }
 
Parameter
Name Description
privateCloud String

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetNsxCredentialsCallable()

public final UnaryCallable<ResetNsxCredentialsRequest,Operation> resetNsxCredentialsCallable()

Resets credentials of the NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetNsxCredentialsRequest request =
       ResetNsxCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.resetNsxCredentialsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ResetNsxCredentialsRequest,Operation>

resetNsxCredentialsOperationCallable()

public final OperationCallable<ResetNsxCredentialsRequest,PrivateCloud,OperationMetadata> resetNsxCredentialsOperationCallable()

Resets credentials of the NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetNsxCredentialsRequest request =
       ResetNsxCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.resetNsxCredentialsOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<ResetNsxCredentialsRequest,PrivateCloud,OperationMetadata>

resetVcenterCredentialsAsync(PrivateCloudName privateCloud)

public final OperationFuture<PrivateCloud,OperationMetadata> resetVcenterCredentialsAsync(PrivateCloudName privateCloud)

Resets credentials of the Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.resetVcenterCredentialsAsync(privateCloud).get();
 }
 
Parameter
Name Description
privateCloud PrivateCloudName

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetVcenterCredentialsAsync(ResetVcenterCredentialsRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> resetVcenterCredentialsAsync(ResetVcenterCredentialsRequest request)

Resets credentials of the Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetVcenterCredentialsRequest request =
       ResetVcenterCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setUsername("username-265713450")
           .build();
   PrivateCloud response = vmwareEngineClient.resetVcenterCredentialsAsync(request).get();
 }
 
Parameter
Name Description
request ResetVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetVcenterCredentialsAsync(String privateCloud)

public final OperationFuture<PrivateCloud,OperationMetadata> resetVcenterCredentialsAsync(String privateCloud)

Resets credentials of the Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   PrivateCloud response = vmwareEngineClient.resetVcenterCredentialsAsync(privateCloud).get();
 }
 
Parameter
Name Description
privateCloud String

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

resetVcenterCredentialsCallable()

public final UnaryCallable<ResetVcenterCredentialsRequest,Operation> resetVcenterCredentialsCallable()

Resets credentials of the Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetVcenterCredentialsRequest request =
       ResetVcenterCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setUsername("username-265713450")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.resetVcenterCredentialsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ResetVcenterCredentialsRequest,Operation>

resetVcenterCredentialsOperationCallable()

public final OperationCallable<ResetVcenterCredentialsRequest,PrivateCloud,OperationMetadata> resetVcenterCredentialsOperationCallable()

Resets credentials of the Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ResetVcenterCredentialsRequest request =
       ResetVcenterCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .setUsername("username-265713450")
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.resetVcenterCredentialsOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<ResetVcenterCredentialsRequest,PrivateCloud,OperationMetadata>

revokeDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

public final OperationFuture<DnsBindPermission,OperationMetadata> revokeDnsBindPermissionAsync(DnsBindPermissionName name, Principal principal)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DnsBindPermissionName name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]");
   Principal principal = Principal.newBuilder().build();
   DnsBindPermission response =
       vmwareEngineClient.revokeDnsBindPermissionAsync(name, principal).get();
 }
 
Parameters
Name Description
name DnsBindPermissionName

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 Principal

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

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

revokeDnsBindPermissionAsync(RevokeDnsBindPermissionRequest request)

public final OperationFuture<DnsBindPermission,OperationMetadata> revokeDnsBindPermissionAsync(RevokeDnsBindPermissionRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RevokeDnsBindPermissionRequest request =
       RevokeDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   DnsBindPermission response = vmwareEngineClient.revokeDnsBindPermissionAsync(request).get();
 }
 
Parameter
Name Description
request RevokeDnsBindPermissionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

revokeDnsBindPermissionAsync(String name, Principal principal)

public final OperationFuture<DnsBindPermission,OperationMetadata> revokeDnsBindPermissionAsync(String name, Principal principal)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString();
   Principal principal = Principal.newBuilder().build();
   DnsBindPermission response =
       vmwareEngineClient.revokeDnsBindPermissionAsync(name, principal).get();
 }
 
Parameters
Name Description
name String

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 Principal

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

Returns
Type Description
OperationFuture<DnsBindPermission,OperationMetadata>

revokeDnsBindPermissionCallable()

public final UnaryCallable<RevokeDnsBindPermissionRequest,Operation> revokeDnsBindPermissionCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RevokeDnsBindPermissionRequest request =
       RevokeDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.revokeDnsBindPermissionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RevokeDnsBindPermissionRequest,Operation>

revokeDnsBindPermissionOperationCallable()

public final OperationCallable<RevokeDnsBindPermissionRequest,DnsBindPermission,OperationMetadata> revokeDnsBindPermissionOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   RevokeDnsBindPermissionRequest request =
       RevokeDnsBindPermissionRequest.newBuilder()
           .setName(DnsBindPermissionName.of("[PROJECT]", "[LOCATION]").toString())
           .setPrincipal(Principal.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<DnsBindPermission, OperationMetadata> future =
       vmwareEngineClient.revokeDnsBindPermissionOperationCallable().futureCall(request);
   // Do something.
   DnsBindPermission response = future.get();
 }
 
Returns
Type Description
OperationCallable<RevokeDnsBindPermissionRequest,DnsBindPermission,OperationMetadata>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = vmwareEngineClient.setIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = vmwareEngineClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

showNsxCredentials(PrivateCloudName privateCloud)

public final Credentials showNsxCredentials(PrivateCloudName privateCloud)

Gets details of credentials for NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   Credentials response = vmwareEngineClient.showNsxCredentials(privateCloud);
 }
 
Parameter
Name Description
privateCloud PrivateCloudName

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

Returns
Type Description
Credentials

showNsxCredentials(ShowNsxCredentialsRequest request)

public final Credentials showNsxCredentials(ShowNsxCredentialsRequest request)

Gets details of credentials for NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ShowNsxCredentialsRequest request =
       ShowNsxCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   Credentials response = vmwareEngineClient.showNsxCredentials(request);
 }
 
Parameter
Name Description
request ShowNsxCredentialsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Credentials

showNsxCredentials(String privateCloud)

public final Credentials showNsxCredentials(String privateCloud)

Gets details of credentials for NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   Credentials response = vmwareEngineClient.showNsxCredentials(privateCloud);
 }
 
Parameter
Name Description
privateCloud String

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

Returns
Type Description
Credentials

showNsxCredentialsCallable()

public final UnaryCallable<ShowNsxCredentialsRequest,Credentials> showNsxCredentialsCallable()

Gets details of credentials for NSX appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ShowNsxCredentialsRequest request =
       ShowNsxCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .build();
   ApiFuture<Credentials> future =
       vmwareEngineClient.showNsxCredentialsCallable().futureCall(request);
   // Do something.
   Credentials response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ShowNsxCredentialsRequest,Credentials>

showVcenterCredentials(PrivateCloudName privateCloud)

public final Credentials showVcenterCredentials(PrivateCloudName privateCloud)

Gets details of credentials for Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   Credentials response = vmwareEngineClient.showVcenterCredentials(privateCloud);
 }
 
Parameter
Name Description
privateCloud PrivateCloudName

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

Returns
Type Description
Credentials

showVcenterCredentials(ShowVcenterCredentialsRequest request)

public final Credentials showVcenterCredentials(ShowVcenterCredentialsRequest request)

Gets details of credentials for Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ShowVcenterCredentialsRequest request =
       ShowVcenterCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setUsername("username-265713450")
           .build();
   Credentials response = vmwareEngineClient.showVcenterCredentials(request);
 }
 
Parameter
Name Description
request ShowVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Credentials

showVcenterCredentials(String privateCloud)

public final Credentials showVcenterCredentials(String privateCloud)

Gets details of credentials for Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String privateCloud =
       PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   Credentials response = vmwareEngineClient.showVcenterCredentials(privateCloud);
 }
 
Parameter
Name Description
privateCloud String

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

Returns
Type Description
Credentials

showVcenterCredentialsCallable()

public final UnaryCallable<ShowVcenterCredentialsRequest,Credentials> showVcenterCredentialsCallable()

Gets details of credentials for Vcenter appliance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ShowVcenterCredentialsRequest request =
       ShowVcenterCredentialsRequest.newBuilder()
           .setPrivateCloud(
               PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setUsername("username-265713450")
           .build();
   ApiFuture<Credentials> future =
       vmwareEngineClient.showVcenterCredentialsCallable().futureCall(request);
   // Do something.
   Credentials response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ShowVcenterCredentialsRequest,Credentials>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = vmwareEngineClient.testIamPermissions(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClusterName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]", "[CLUSTER]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       vmwareEngineClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

undeletePrivateCloudAsync(PrivateCloudName name)

public final OperationFuture<PrivateCloud,OperationMetadata> undeletePrivateCloudAsync(PrivateCloudName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloudName name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
   PrivateCloud response = vmwareEngineClient.undeletePrivateCloudAsync(name).get();
 }
 
Parameter
Name Description
name PrivateCloudName

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

undeletePrivateCloudAsync(UndeletePrivateCloudRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> undeletePrivateCloudAsync(UndeletePrivateCloudRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UndeletePrivateCloudRequest request =
       UndeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   PrivateCloud response = vmwareEngineClient.undeletePrivateCloudAsync(request).get();
 }
 
Parameter
Name Description
request UndeletePrivateCloudRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

undeletePrivateCloudAsync(String name)

public final OperationFuture<PrivateCloud,OperationMetadata> undeletePrivateCloudAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   String name = PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString();
   PrivateCloud response = vmwareEngineClient.undeletePrivateCloudAsync(name).get();
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

undeletePrivateCloudCallable()

public final UnaryCallable<UndeletePrivateCloudRequest,Operation> undeletePrivateCloudCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UndeletePrivateCloudRequest request =
       UndeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.undeletePrivateCloudCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UndeletePrivateCloudRequest,Operation>

undeletePrivateCloudOperationCallable()

public final OperationCallable<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata> undeletePrivateCloudOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UndeletePrivateCloudRequest request =
       UndeletePrivateCloudRequest.newBuilder()
           .setName(PrivateCloudName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.undeletePrivateCloudOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata>

updateClusterAsync(Cluster cluster, FieldMask updateMask)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(Cluster cluster, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Cluster response = vmwareEngineClient.updateClusterAsync(cluster, updateMask).get();
 }
 
Parameters
Name Description
cluster Cluster

Required. The description of the cluster.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

updateClusterAsync(UpdateClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(UpdateClusterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   Cluster response = vmwareEngineClient.updateClusterAsync(request).get();
 }
 
Parameter
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Cluster,OperationMetadata>

updateClusterCallable()

public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = vmwareEngineClient.updateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateClusterRequest,Operation>

updateClusterOperationCallable()

public final OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       vmwareEngineClient.updateClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata>

updateDnsForwardingAsync(DnsForwarding dnsForwarding, FieldMask updateMask)

public final OperationFuture<DnsForwarding,OperationMetadata> updateDnsForwardingAsync(DnsForwarding dnsForwarding, FieldMask updateMask)

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   DnsForwarding dnsForwarding = DnsForwarding.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DnsForwarding response =
       vmwareEngineClient.updateDnsForwardingAsync(dnsForwarding, updateMask).get();
 }
 
Parameters
Name Description
dnsForwarding DnsForwarding

Required. DnsForwarding config details.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<DnsForwarding,OperationMetadata>

updateDnsForwardingAsync(UpdateDnsForwardingRequest request)

public final OperationFuture<DnsForwarding,OperationMetadata> updateDnsForwardingAsync(UpdateDnsForwardingRequest request)

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateDnsForwardingRequest request =
       UpdateDnsForwardingRequest.newBuilder()
           .setDnsForwarding(DnsForwarding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   DnsForwarding response = vmwareEngineClient.updateDnsForwardingAsync(request).get();
 }
 
Parameter
Name Description
request UpdateDnsForwardingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DnsForwarding,OperationMetadata>

updateDnsForwardingCallable()

public final UnaryCallable<UpdateDnsForwardingRequest,Operation> updateDnsForwardingCallable()

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateDnsForwardingRequest request =
       UpdateDnsForwardingRequest.newBuilder()
           .setDnsForwarding(DnsForwarding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateDnsForwardingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDnsForwardingRequest,Operation>

updateDnsForwardingOperationCallable()

public final OperationCallable<UpdateDnsForwardingRequest,DnsForwarding,OperationMetadata> updateDnsForwardingOperationCallable()

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateDnsForwardingRequest request =
       UpdateDnsForwardingRequest.newBuilder()
           .setDnsForwarding(DnsForwarding.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<DnsForwarding, OperationMetadata> future =
       vmwareEngineClient.updateDnsForwardingOperationCallable().futureCall(request);
   // Do something.
   DnsForwarding response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateDnsForwardingRequest,DnsForwarding,OperationMetadata>

updateExternalAccessRuleAsync(ExternalAccessRule externalAccessRule, FieldMask updateMask)

public final OperationFuture<ExternalAccessRule,OperationMetadata> updateExternalAccessRuleAsync(ExternalAccessRule externalAccessRule, FieldMask updateMask)

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAccessRule externalAccessRule = ExternalAccessRule.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ExternalAccessRule response =
       vmwareEngineClient.updateExternalAccessRuleAsync(externalAccessRule, updateMask).get();
 }
 
Parameters
Name Description
externalAccessRule ExternalAccessRule

Required. Description of the external access rule.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<ExternalAccessRule,OperationMetadata>

updateExternalAccessRuleAsync(UpdateExternalAccessRuleRequest request)

public final OperationFuture<ExternalAccessRule,OperationMetadata> updateExternalAccessRuleAsync(UpdateExternalAccessRuleRequest request)

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAccessRuleRequest request =
       UpdateExternalAccessRuleRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ExternalAccessRule response = vmwareEngineClient.updateExternalAccessRuleAsync(request).get();
 }
 
Parameter
Name Description
request UpdateExternalAccessRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ExternalAccessRule,OperationMetadata>

updateExternalAccessRuleCallable()

public final UnaryCallable<UpdateExternalAccessRuleRequest,Operation> updateExternalAccessRuleCallable()

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAccessRuleRequest request =
       UpdateExternalAccessRuleRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateExternalAccessRuleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateExternalAccessRuleRequest,Operation>

updateExternalAccessRuleOperationCallable()

public final OperationCallable<UpdateExternalAccessRuleRequest,ExternalAccessRule,OperationMetadata> updateExternalAccessRuleOperationCallable()

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAccessRuleRequest request =
       UpdateExternalAccessRuleRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAccessRule(ExternalAccessRule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ExternalAccessRule, OperationMetadata> future =
       vmwareEngineClient.updateExternalAccessRuleOperationCallable().futureCall(request);
   // Do something.
   ExternalAccessRule response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateExternalAccessRuleRequest,ExternalAccessRule,OperationMetadata>

updateExternalAddressAsync(ExternalAddress externalAddress, FieldMask updateMask)

public final OperationFuture<ExternalAddress,OperationMetadata> updateExternalAddressAsync(ExternalAddress externalAddress, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ExternalAddress externalAddress = ExternalAddress.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ExternalAddress response =
       vmwareEngineClient.updateExternalAddressAsync(externalAddress, updateMask).get();
 }
 
Parameters
Name Description
externalAddress ExternalAddress

Required. External IP address description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<ExternalAddress,OperationMetadata>

updateExternalAddressAsync(UpdateExternalAddressRequest request)

public final OperationFuture<ExternalAddress,OperationMetadata> updateExternalAddressAsync(UpdateExternalAddressRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAddressRequest request =
       UpdateExternalAddressRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ExternalAddress response = vmwareEngineClient.updateExternalAddressAsync(request).get();
 }
 
Parameter
Name Description
request UpdateExternalAddressRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ExternalAddress,OperationMetadata>

updateExternalAddressCallable()

public final UnaryCallable<UpdateExternalAddressRequest,Operation> updateExternalAddressCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAddressRequest request =
       UpdateExternalAddressRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateExternalAddressCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateExternalAddressRequest,Operation>

updateExternalAddressOperationCallable()

public final OperationCallable<UpdateExternalAddressRequest,ExternalAddress,OperationMetadata> updateExternalAddressOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateExternalAddressRequest request =
       UpdateExternalAddressRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setExternalAddress(ExternalAddress.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ExternalAddress, OperationMetadata> future =
       vmwareEngineClient.updateExternalAddressOperationCallable().futureCall(request);
   // Do something.
   ExternalAddress response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateExternalAddressRequest,ExternalAddress,OperationMetadata>

updateLoggingServerAsync(LoggingServer loggingServer, FieldMask updateMask)

public final OperationFuture<LoggingServer,OperationMetadata> updateLoggingServerAsync(LoggingServer loggingServer, FieldMask updateMask)

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   LoggingServer loggingServer = LoggingServer.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   LoggingServer response =
       vmwareEngineClient.updateLoggingServerAsync(loggingServer, updateMask).get();
 }
 
Parameters
Name Description
loggingServer LoggingServer

Required. Logging server description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<LoggingServer,OperationMetadata>

updateLoggingServerAsync(UpdateLoggingServerRequest request)

public final OperationFuture<LoggingServer,OperationMetadata> updateLoggingServerAsync(UpdateLoggingServerRequest request)

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateLoggingServerRequest request =
       UpdateLoggingServerRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   LoggingServer response = vmwareEngineClient.updateLoggingServerAsync(request).get();
 }
 
Parameter
Name Description
request UpdateLoggingServerRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<LoggingServer,OperationMetadata>

updateLoggingServerCallable()

public final UnaryCallable<UpdateLoggingServerRequest,Operation> updateLoggingServerCallable()

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateLoggingServerRequest request =
       UpdateLoggingServerRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateLoggingServerCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateLoggingServerRequest,Operation>

updateLoggingServerOperationCallable()

public final OperationCallable<UpdateLoggingServerRequest,LoggingServer,OperationMetadata> updateLoggingServerOperationCallable()

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateLoggingServerRequest request =
       UpdateLoggingServerRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLoggingServer(LoggingServer.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<LoggingServer, OperationMetadata> future =
       vmwareEngineClient.updateLoggingServerOperationCallable().futureCall(request);
   // Do something.
   LoggingServer response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateLoggingServerRequest,LoggingServer,OperationMetadata>

updateManagementDnsZoneBindingAsync(ManagementDnsZoneBinding managementDnsZoneBinding, FieldMask updateMask)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> updateManagementDnsZoneBindingAsync(ManagementDnsZoneBinding managementDnsZoneBinding, FieldMask updateMask)

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   ManagementDnsZoneBinding managementDnsZoneBinding =
       ManagementDnsZoneBinding.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ManagementDnsZoneBinding response =
       vmwareEngineClient
           .updateManagementDnsZoneBindingAsync(managementDnsZoneBinding, updateMask)
           .get();
 }
 
Parameters
Name Description
managementDnsZoneBinding ManagementDnsZoneBinding

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

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

updateManagementDnsZoneBindingAsync(UpdateManagementDnsZoneBindingRequest request)

public final OperationFuture<ManagementDnsZoneBinding,OperationMetadata> updateManagementDnsZoneBindingAsync(UpdateManagementDnsZoneBindingRequest request)

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateManagementDnsZoneBindingRequest request =
       UpdateManagementDnsZoneBindingRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ManagementDnsZoneBinding response =
       vmwareEngineClient.updateManagementDnsZoneBindingAsync(request).get();
 }
 
Parameter
Name Description
request UpdateManagementDnsZoneBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ManagementDnsZoneBinding,OperationMetadata>

updateManagementDnsZoneBindingCallable()

public final UnaryCallable<UpdateManagementDnsZoneBindingRequest,Operation> updateManagementDnsZoneBindingCallable()

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateManagementDnsZoneBindingRequest request =
       UpdateManagementDnsZoneBindingRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateManagementDnsZoneBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateManagementDnsZoneBindingRequest,Operation>

updateManagementDnsZoneBindingOperationCallable()

public final OperationCallable<UpdateManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata> updateManagementDnsZoneBindingOperationCallable()

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateManagementDnsZoneBindingRequest request =
       UpdateManagementDnsZoneBindingRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setManagementDnsZoneBinding(ManagementDnsZoneBinding.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<ManagementDnsZoneBinding, OperationMetadata> future =
       vmwareEngineClient.updateManagementDnsZoneBindingOperationCallable().futureCall(request);
   // Do something.
   ManagementDnsZoneBinding response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateManagementDnsZoneBindingRequest,ManagementDnsZoneBinding,OperationMetadata>

updateNetworkPeeringAsync(NetworkPeering networkPeering, FieldMask updateMask)

public final OperationFuture<NetworkPeering,OperationMetadata> updateNetworkPeeringAsync(NetworkPeering networkPeering, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPeering networkPeering = NetworkPeering.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   NetworkPeering response =
       vmwareEngineClient.updateNetworkPeeringAsync(networkPeering, updateMask).get();
 }
 
Parameters
Name Description
networkPeering NetworkPeering

Required. Network peering description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<NetworkPeering,OperationMetadata>

updateNetworkPeeringAsync(UpdateNetworkPeeringRequest request)

public final OperationFuture<NetworkPeering,OperationMetadata> updateNetworkPeeringAsync(UpdateNetworkPeeringRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPeeringRequest request =
       UpdateNetworkPeeringRequest.newBuilder()
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NetworkPeering response = vmwareEngineClient.updateNetworkPeeringAsync(request).get();
 }
 
Parameter
Name Description
request UpdateNetworkPeeringRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NetworkPeering,OperationMetadata>

updateNetworkPeeringCallable()

public final UnaryCallable<UpdateNetworkPeeringRequest,Operation> updateNetworkPeeringCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPeeringRequest request =
       UpdateNetworkPeeringRequest.newBuilder()
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateNetworkPeeringCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateNetworkPeeringRequest,Operation>

updateNetworkPeeringOperationCallable()

public final OperationCallable<UpdateNetworkPeeringRequest,NetworkPeering,OperationMetadata> updateNetworkPeeringOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPeeringRequest request =
       UpdateNetworkPeeringRequest.newBuilder()
           .setNetworkPeering(NetworkPeering.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NetworkPeering, OperationMetadata> future =
       vmwareEngineClient.updateNetworkPeeringOperationCallable().futureCall(request);
   // Do something.
   NetworkPeering response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateNetworkPeeringRequest,NetworkPeering,OperationMetadata>

updateNetworkPolicyAsync(NetworkPolicy networkPolicy, FieldMask updateMask)

public final OperationFuture<NetworkPolicy,OperationMetadata> updateNetworkPolicyAsync(NetworkPolicy networkPolicy, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   NetworkPolicy networkPolicy = NetworkPolicy.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   NetworkPolicy response =
       vmwareEngineClient.updateNetworkPolicyAsync(networkPolicy, updateMask).get();
 }
 
Parameters
Name Description
networkPolicy NetworkPolicy

Required. Network policy description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<NetworkPolicy,OperationMetadata>

updateNetworkPolicyAsync(UpdateNetworkPolicyRequest request)

public final OperationFuture<NetworkPolicy,OperationMetadata> updateNetworkPolicyAsync(UpdateNetworkPolicyRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPolicyRequest request =
       UpdateNetworkPolicyRequest.newBuilder()
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   NetworkPolicy response = vmwareEngineClient.updateNetworkPolicyAsync(request).get();
 }
 
Parameter
Name Description
request UpdateNetworkPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NetworkPolicy,OperationMetadata>

updateNetworkPolicyCallable()

public final UnaryCallable<UpdateNetworkPolicyRequest,Operation> updateNetworkPolicyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPolicyRequest request =
       UpdateNetworkPolicyRequest.newBuilder()
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateNetworkPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateNetworkPolicyRequest,Operation>

updateNetworkPolicyOperationCallable()

public final OperationCallable<UpdateNetworkPolicyRequest,NetworkPolicy,OperationMetadata> updateNetworkPolicyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateNetworkPolicyRequest request =
       UpdateNetworkPolicyRequest.newBuilder()
           .setNetworkPolicy(NetworkPolicy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NetworkPolicy, OperationMetadata> future =
       vmwareEngineClient.updateNetworkPolicyOperationCallable().futureCall(request);
   // Do something.
   NetworkPolicy response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateNetworkPolicyRequest,NetworkPolicy,OperationMetadata>

updatePrivateCloudAsync(PrivateCloud privateCloud, FieldMask updateMask)

public final OperationFuture<PrivateCloud,OperationMetadata> updatePrivateCloudAsync(PrivateCloud privateCloud, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateCloud privateCloud = PrivateCloud.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PrivateCloud response =
       vmwareEngineClient.updatePrivateCloudAsync(privateCloud, updateMask).get();
 }
 
Parameters
Name Description
privateCloud PrivateCloud

Required. Private cloud description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

updatePrivateCloudAsync(UpdatePrivateCloudRequest request)

public final OperationFuture<PrivateCloud,OperationMetadata> updatePrivateCloudAsync(UpdatePrivateCloudRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateCloudRequest request =
       UpdatePrivateCloudRequest.newBuilder()
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   PrivateCloud response = vmwareEngineClient.updatePrivateCloudAsync(request).get();
 }
 
Parameter
Name Description
request UpdatePrivateCloudRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateCloud,OperationMetadata>

updatePrivateCloudCallable()

public final UnaryCallable<UpdatePrivateCloudRequest,Operation> updatePrivateCloudCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateCloudRequest request =
       UpdatePrivateCloudRequest.newBuilder()
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updatePrivateCloudCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdatePrivateCloudRequest,Operation>

updatePrivateCloudOperationCallable()

public final OperationCallable<UpdatePrivateCloudRequest,PrivateCloud,OperationMetadata> updatePrivateCloudOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateCloudRequest request =
       UpdatePrivateCloudRequest.newBuilder()
           .setPrivateCloud(PrivateCloud.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.updatePrivateCloudOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdatePrivateCloudRequest,PrivateCloud,OperationMetadata>

updatePrivateConnectionAsync(PrivateConnection privateConnection, FieldMask updateMask)

public final OperationFuture<PrivateConnection,OperationMetadata> updatePrivateConnectionAsync(PrivateConnection privateConnection, FieldMask updateMask)

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   PrivateConnection privateConnection = PrivateConnection.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PrivateConnection response =
       vmwareEngineClient.updatePrivateConnectionAsync(privateConnection, updateMask).get();
 }
 
Parameters
Name Description
privateConnection PrivateConnection

Required. Private connection description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<PrivateConnection,OperationMetadata>

updatePrivateConnectionAsync(UpdatePrivateConnectionRequest request)

public final OperationFuture<PrivateConnection,OperationMetadata> updatePrivateConnectionAsync(UpdatePrivateConnectionRequest request)

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateConnectionRequest request =
       UpdatePrivateConnectionRequest.newBuilder()
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   PrivateConnection response = vmwareEngineClient.updatePrivateConnectionAsync(request).get();
 }
 
Parameter
Name Description
request UpdatePrivateConnectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PrivateConnection,OperationMetadata>

updatePrivateConnectionCallable()

public final UnaryCallable<UpdatePrivateConnectionRequest,Operation> updatePrivateConnectionCallable()

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateConnectionRequest request =
       UpdatePrivateConnectionRequest.newBuilder()
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updatePrivateConnectionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdatePrivateConnectionRequest,Operation>

updatePrivateConnectionOperationCallable()

public final OperationCallable<UpdatePrivateConnectionRequest,PrivateConnection,OperationMetadata> updatePrivateConnectionOperationCallable()

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdatePrivateConnectionRequest request =
       UpdatePrivateConnectionRequest.newBuilder()
           .setPrivateConnection(PrivateConnection.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PrivateConnection, OperationMetadata> future =
       vmwareEngineClient.updatePrivateConnectionOperationCallable().futureCall(request);
   // Do something.
   PrivateConnection response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdatePrivateConnectionRequest,PrivateConnection,OperationMetadata>

updateSubnetAsync(Subnet subnet, FieldMask updateMask)

public final OperationFuture<Subnet,OperationMetadata> updateSubnetAsync(Subnet subnet, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   Subnet subnet = Subnet.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Subnet response = vmwareEngineClient.updateSubnetAsync(subnet, updateMask).get();
 }
 
Parameters
Name Description
subnet Subnet

Required. Subnet description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<Subnet,OperationMetadata>

updateSubnetAsync(UpdateSubnetRequest request)

public final OperationFuture<Subnet,OperationMetadata> updateSubnetAsync(UpdateSubnetRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateSubnetRequest request =
       UpdateSubnetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSubnet(Subnet.newBuilder().build())
           .build();
   Subnet response = vmwareEngineClient.updateSubnetAsync(request).get();
 }
 
Parameter
Name Description
request UpdateSubnetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Subnet,OperationMetadata>

updateSubnetCallable()

public final UnaryCallable<UpdateSubnetRequest,Operation> updateSubnetCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateSubnetRequest request =
       UpdateSubnetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSubnet(Subnet.newBuilder().build())
           .build();
   ApiFuture<Operation> future = vmwareEngineClient.updateSubnetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateSubnetRequest,Operation>

updateSubnetOperationCallable()

public final OperationCallable<UpdateSubnetRequest,Subnet,OperationMetadata> updateSubnetOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateSubnetRequest request =
       UpdateSubnetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setSubnet(Subnet.newBuilder().build())
           .build();
   OperationFuture<Subnet, OperationMetadata> future =
       vmwareEngineClient.updateSubnetOperationCallable().futureCall(request);
   // Do something.
   Subnet response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateSubnetRequest,Subnet,OperationMetadata>

updateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest request)

public final OperationFuture<VmwareEngineNetwork,OperationMetadata> updateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest request)

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateVmwareEngineNetworkRequest request =
       UpdateVmwareEngineNetworkRequest.newBuilder()
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   VmwareEngineNetwork response =
       vmwareEngineClient.updateVmwareEngineNetworkAsync(request).get();
 }
 
Parameter
Name Description
request UpdateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<VmwareEngineNetwork,OperationMetadata>

updateVmwareEngineNetworkAsync(VmwareEngineNetwork vmwareEngineNetwork, FieldMask updateMask)

public final OperationFuture<VmwareEngineNetwork,OperationMetadata> updateVmwareEngineNetworkAsync(VmwareEngineNetwork vmwareEngineNetwork, FieldMask updateMask)

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   VmwareEngineNetwork vmwareEngineNetwork = VmwareEngineNetwork.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   VmwareEngineNetwork response =
       vmwareEngineClient.updateVmwareEngineNetworkAsync(vmwareEngineNetwork, updateMask).get();
 }
 
Parameters
Name Description
vmwareEngineNetwork VmwareEngineNetwork

Required. VMware Engine network description.

updateMask FieldMask

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.

Returns
Type Description
OperationFuture<VmwareEngineNetwork,OperationMetadata>

updateVmwareEngineNetworkCallable()

public final UnaryCallable<UpdateVmwareEngineNetworkRequest,Operation> updateVmwareEngineNetworkCallable()

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateVmwareEngineNetworkRequest request =
       UpdateVmwareEngineNetworkRequest.newBuilder()
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.updateVmwareEngineNetworkCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateVmwareEngineNetworkRequest,Operation>

updateVmwareEngineNetworkOperationCallable()

public final OperationCallable<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata> updateVmwareEngineNetworkOperationCallable()

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VmwareEngineClient vmwareEngineClient = VmwareEngineClient.create()) {
   UpdateVmwareEngineNetworkRequest request =
       UpdateVmwareEngineNetworkRequest.newBuilder()
           .setVmwareEngineNetwork(VmwareEngineNetwork.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<VmwareEngineNetwork, OperationMetadata> future =
       vmwareEngineClient.updateVmwareEngineNetworkOperationCallable().futureCall(request);
   // Do something.
   VmwareEngineNetwork response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>