Class VmwareEngineClient (0.5.0)

public class VmwareEngineClient implements BackgroundResource

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

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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

Implements

BackgroundResource

Static Methods

create()

public static final VmwareEngineClient create()

Constructs an instance of VmwareEngineClient with default settings.

Returns
TypeDescription
VmwareEngineClient
Exceptions
TypeDescription
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
NameDescription
settingsVmwareEngineSettings
Returns
TypeDescription
VmwareEngineClient
Exceptions
TypeDescription
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
NameDescription
stubVmwareEngineStub
Returns
TypeDescription
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
NameDescription
settingsVmwareEngineSettings

VmwareEngineClient(VmwareEngineStub stub)

protected VmwareEngineClient(VmwareEngineStub stub)
Parameter
NameDescription
stubVmwareEngineStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
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
NameDescription
requestCreateClusterRequest

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

Returns
TypeDescription
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
NameDescription
parentPrivateCloudName

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

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

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
TypeDescription
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
NameDescription
parentString

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

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<CreateClusterRequest,Cluster,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
NameDescription
requestCreateHcxActivationKeyRequest

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

Returns
TypeDescription
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
NameDescription
parentPrivateCloudName

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

hcxActivationKeyHcxActivationKey

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

hcxActivationKeyIdString

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
TypeDescription
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
NameDescription
parentString

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

hcxActivationKeyHcxActivationKey

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

hcxActivationKeyIdString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<CreateHcxActivationKeyRequest,HcxActivationKey,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
NameDescription
requestCreateNetworkPolicyRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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

networkPolicyNetworkPolicy

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

networkPolicyIdString

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
TypeDescription
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
NameDescription
parentString

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

networkPolicyNetworkPolicy

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

networkPolicyIdString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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 can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
NameDescription
requestCreatePrivateCloudRequest

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

Returns
TypeDescription
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 can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
NameDescription
parentLocationName

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

privateCloudPrivateCloud

Required. The initial description of the new private cloud.

privateCloudIdString

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
TypeDescription
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 can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
NameDescription
parentString

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

privateCloudPrivateCloud

Required. The initial description of the new private cloud.

privateCloudIdString

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
TypeDescription
OperationFuture<PrivateCloud,OperationMetadata>

createPrivateCloudCallable()

public final UnaryCallable<CreatePrivateCloudRequest,Operation> createPrivateCloudCallable()

Creates a new PrivateCloud resource in a given project and location. Private clouds can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
TypeDescription
UnaryCallable<CreatePrivateCloudRequest,Operation>

createPrivateCloudOperationCallable()

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

Creates a new PrivateCloud resource in a given project and location. Private clouds can only be created in zones, regional private clouds are not supported.

Creating a private cloud also creates a management cluster for that private cloud.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
TypeDescription
OperationCallable<CreatePrivateCloudRequest,PrivateCloud,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
NameDescription
requestCreateVmwareEngineNetworkRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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

vmwareEngineNetworkVmwareEngineNetwork

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

vmwareEngineNetworkIdString

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
TypeDescription
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
NameDescription
parentString

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

vmwareEngineNetworkVmwareEngineNetwork

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

vmwareEngineNetworkIdString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
nameClusterName

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
TypeDescription
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
NameDescription
requestDeleteClusterRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<DeleteClusterRequest,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
NameDescription
requestDeleteNetworkPolicyRequest

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

Returns
TypeDescription
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
NameDescription
nameNetworkPolicyName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestDeletePrivateCloudRequest

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

Returns
TypeDescription
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
NameDescription
namePrivateCloudName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<DeletePrivateCloudRequest,PrivateCloud,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
NameDescription
requestDeleteVmwareEngineNetworkRequest

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

Returns
TypeDescription
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
NameDescription
nameVmwareEngineNetworkName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<DeleteVmwareEngineNetworkRequest,Empty,OperationMetadata>

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
NameDescription
nameClusterName

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
TypeDescription
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
NameDescription
requestGetClusterRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
UnaryCallable<GetClusterRequest,Cluster>

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
NameDescription
requestGetHcxActivationKeyRequest

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

Returns
TypeDescription
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
NameDescription
nameHcxActivationKeyName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestcom.google.cloud.location.GetLocationRequest

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

Returns
TypeDescription
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
TypeDescription
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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
NameDescription
requestGetNetworkPolicyRequest

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

Returns
TypeDescription
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
NameDescription
nameNetworkPolicyName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
UnaryCallable<GetNetworkPolicyRequest,NetworkPolicy>

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
NameDescription
requestGetNodeTypeRequest

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

Returns
TypeDescription
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
NameDescription
nameNodeTypeName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestGetPrivateCloudRequest

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

Returns
TypeDescription
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
NameDescription
namePrivateCloudName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
UnaryCallable<GetPrivateCloudRequest,PrivateCloud>

getSettings()

public final VmwareEngineSettings getSettings()
Returns
TypeDescription
VmwareEngineSettings

getStub()

public VmwareEngineStub getStub()
Returns
TypeDescription
VmwareEngineStub

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
NameDescription
requestGetVmwareEngineNetworkRequest

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

Returns
TypeDescription
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
NameDescription
nameVmwareEngineNetworkName

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
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
UnaryCallable<GetVmwareEngineNetworkRequest,VmwareEngineNetwork>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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
NameDescription
requestListClustersRequest

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

Returns
TypeDescription
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
NameDescription
parentPrivateCloudName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListClustersRequest,ListClustersPagedResponse>

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
NameDescription
requestListHcxActivationKeysRequest

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

Returns
TypeDescription
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
NameDescription
parentPrivateCloudName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestcom.google.cloud.location.ListLocationsRequest

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

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
NameDescription
requestListNetworkPoliciesRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestListNodeTypesRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListNodeTypesRequest,ListNodeTypesPagedResponse>

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
NameDescription
requestListPrivateCloudsRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListPrivateCloudsRequest,ListPrivateCloudsPagedResponse>

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
NameDescription
requestListSubnetsRequest

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

Returns
TypeDescription
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
NameDescription
parentPrivateCloudName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestListVmwareEngineNetworksRequest

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

Returns
TypeDescription
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
NameDescription
parentLocationName

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
TypeDescription
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
NameDescription
parentString

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
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListVmwareEngineNetworksRequest,ListVmwareEngineNetworksPagedResponse>

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
NameDescription
privateCloudPrivateCloudName

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
TypeDescription
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
NameDescription
requestResetNsxCredentialsRequest

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

Returns
TypeDescription
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
NameDescription
privateCloudString

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
privateCloudPrivateCloudName

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
TypeDescription
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")
           .build();
   PrivateCloud response = vmwareEngineClient.resetVcenterCredentialsAsync(request).get();
 }
 
Parameter
NameDescription
requestResetVcenterCredentialsRequest

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

Returns
TypeDescription
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
NameDescription
privateCloudString

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
TypeDescription
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")
           .build();
   ApiFuture<Operation> future =
       vmwareEngineClient.resetVcenterCredentialsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
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")
           .build();
   OperationFuture<PrivateCloud, OperationMetadata> future =
       vmwareEngineClient.resetVcenterCredentialsOperationCallable().futureCall(request);
   // Do something.
   PrivateCloud response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ResetVcenterCredentialsRequest,PrivateCloud,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
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
privateCloudPrivateCloudName

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
TypeDescription
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
NameDescription
requestShowNsxCredentialsRequest

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

Returns
TypeDescription
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
NameDescription
privateCloudString

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
TypeDescription
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
TypeDescription
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
NameDescription
privateCloudPrivateCloudName

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
TypeDescription
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())
           .build();
   Credentials response = vmwareEngineClient.showVcenterCredentials(request);
 }
 
Parameter
NameDescription
requestShowVcenterCredentialsRequest

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

Returns
TypeDescription
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
NameDescription
privateCloudString

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
TypeDescription
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())
           .build();
   ApiFuture<Credentials> future =
       vmwareEngineClient.showVcenterCredentialsCallable().futureCall(request);
   // Do something.
   Credentials response = future.get();
 }
 
Returns
TypeDescription
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
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
namePrivateCloudName

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
TypeDescription
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
NameDescription
requestUndeletePrivateCloudRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<UndeletePrivateCloudRequest,PrivateCloud,OperationMetadata>

updateClusterAsync(Cluster cluster, FieldMask updateMask)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(Cluster cluster, FieldMask updateMask)

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
NameDescription
clusterCluster

Required. The description of the cluster.

updateMaskFieldMask

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
TypeDescription
OperationFuture<Cluster,OperationMetadata>

updateClusterAsync(UpdateClusterRequest request)

public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(UpdateClusterRequest request)

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
NameDescription
requestUpdateClusterRequest

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

Returns
TypeDescription
OperationFuture<Cluster,OperationMetadata>

updateClusterCallable()

public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
TypeDescription
UnaryCallable<UpdateClusterRequest,Operation>

updateClusterOperationCallable()

public final OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationCallable()

Modifies a Cluster resource. Only the following fields can be updated: node_type_configs.*.node_count. Only fields specified in updateMask are applied.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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
TypeDescription
OperationCallable<UpdateClusterRequest,Cluster,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
NameDescription
networkPolicyNetworkPolicy

Required. Network policy description.

updateMaskFieldMask

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
TypeDescription
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
NameDescription
requestUpdateNetworkPolicyRequest

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
privateCloudPrivateCloud

Required. Private cloud description.

updateMaskFieldMask

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
TypeDescription
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
NameDescription
requestUpdatePrivateCloudRequest

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<UpdatePrivateCloudRequest,PrivateCloud,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
NameDescription
requestUpdateVmwareEngineNetworkRequest

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

Returns
TypeDescription
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
NameDescription
vmwareEngineNetworkVmwareEngineNetwork

Required. VMware Engine network description.

updateMaskFieldMask

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
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<UpdateVmwareEngineNetworkRequest,VmwareEngineNetwork,OperationMetadata>