Package com.google.cloud.vmwareengine.v1 (0.7.0)

A client to VMware Engine API

The interfaces provided are listed below, along with usage samples.

VmwareEngineClient

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

Sample for VmwareEngineClient:


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

Classes

Cluster

A cluster in a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Cluster

Cluster.Builder

A cluster in a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Cluster

ClusterName.Builder

Builder for projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}.

CreateClusterRequest

Request message for VmwareEngine.CreateCluster

Protobuf type google.cloud.vmwareengine.v1.CreateClusterRequest

CreateClusterRequest.Builder

Request message for VmwareEngine.CreateCluster

Protobuf type google.cloud.vmwareengine.v1.CreateClusterRequest

CreateHcxActivationKeyRequest

Request message for VmwareEngine.CreateHcxActivationKey

Protobuf type google.cloud.vmwareengine.v1.CreateHcxActivationKeyRequest

CreateHcxActivationKeyRequest.Builder

Request message for VmwareEngine.CreateHcxActivationKey

Protobuf type google.cloud.vmwareengine.v1.CreateHcxActivationKeyRequest

CreateNetworkPolicyRequest

Request message for VmwareEngine.CreateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.CreateNetworkPolicyRequest

CreateNetworkPolicyRequest.Builder

Request message for VmwareEngine.CreateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.CreateNetworkPolicyRequest

CreatePrivateCloudRequest

Request message for VmwareEngine.CreatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.CreatePrivateCloudRequest

CreatePrivateCloudRequest.Builder

Request message for VmwareEngine.CreatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.CreatePrivateCloudRequest

CreateVmwareEngineNetworkRequest

Request message for VmwareEngine.CreateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.CreateVmwareEngineNetworkRequest

CreateVmwareEngineNetworkRequest.Builder

Request message for VmwareEngine.CreateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.CreateVmwareEngineNetworkRequest

Credentials

Credentials for a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Credentials

Credentials.Builder

Credentials for a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Credentials

DeleteClusterRequest

Request message for VmwareEngine.DeleteCluster

Protobuf type google.cloud.vmwareengine.v1.DeleteClusterRequest

DeleteClusterRequest.Builder

Request message for VmwareEngine.DeleteCluster

Protobuf type google.cloud.vmwareengine.v1.DeleteClusterRequest

DeleteNetworkPolicyRequest

Request message for VmwareEngine.DeleteNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.DeleteNetworkPolicyRequest

DeleteNetworkPolicyRequest.Builder

Request message for VmwareEngine.DeleteNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.DeleteNetworkPolicyRequest

DeletePrivateCloudRequest

Request message for VmwareEngine.DeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.DeletePrivateCloudRequest

DeletePrivateCloudRequest.Builder

Request message for VmwareEngine.DeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.DeletePrivateCloudRequest

DeleteVmwareEngineNetworkRequest

Request message for VmwareEngine.DeleteVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.DeleteVmwareEngineNetworkRequest

DeleteVmwareEngineNetworkRequest.Builder

Request message for VmwareEngine.DeleteVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.DeleteVmwareEngineNetworkRequest

GetClusterRequest

Request message for VmwareEngine.GetCluster

Protobuf type google.cloud.vmwareengine.v1.GetClusterRequest

GetClusterRequest.Builder

Request message for VmwareEngine.GetCluster

Protobuf type google.cloud.vmwareengine.v1.GetClusterRequest

GetHcxActivationKeyRequest

Request message for [VmwareEngine.GetHcxActivationKeys][]

Protobuf type google.cloud.vmwareengine.v1.GetHcxActivationKeyRequest

GetHcxActivationKeyRequest.Builder

Request message for [VmwareEngine.GetHcxActivationKeys][]

Protobuf type google.cloud.vmwareengine.v1.GetHcxActivationKeyRequest

GetNetworkPolicyRequest

Request message for VmwareEngine.GetNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.GetNetworkPolicyRequest

GetNetworkPolicyRequest.Builder

Request message for VmwareEngine.GetNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.GetNetworkPolicyRequest

GetNodeTypeRequest

Request message for VmwareEngine.GetNodeType

Protobuf type google.cloud.vmwareengine.v1.GetNodeTypeRequest

GetNodeTypeRequest.Builder

Request message for VmwareEngine.GetNodeType

Protobuf type google.cloud.vmwareengine.v1.GetNodeTypeRequest

GetPrivateCloudRequest

Request message for VmwareEngine.GetPrivateCloud

Protobuf type google.cloud.vmwareengine.v1.GetPrivateCloudRequest

GetPrivateCloudRequest.Builder

Request message for VmwareEngine.GetPrivateCloud

Protobuf type google.cloud.vmwareengine.v1.GetPrivateCloudRequest

GetVmwareEngineNetworkRequest

Request message for VmwareEngine.GetVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.GetVmwareEngineNetworkRequest

GetVmwareEngineNetworkRequest.Builder

Request message for VmwareEngine.GetVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.GetVmwareEngineNetworkRequest

Hcx

Details about a HCX Cloud Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Hcx

Hcx.Builder

Details about a HCX Cloud Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Hcx

HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones.

Protobuf type google.cloud.vmwareengine.v1.HcxActivationKey

HcxActivationKey.Builder

Protobuf type google.cloud.vmwareengine.v1.HcxActivationKey

HcxActivationKeyName

HcxActivationKeyName.Builder

Builder for projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}.

ListClustersRequest

Request message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersRequest

ListClustersRequest.Builder

Request message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersRequest

ListClustersResponse

Response message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersResponse

ListClustersResponse.Builder

Response message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersResponse

ListHcxActivationKeysRequest

Request message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysRequest

ListHcxActivationKeysRequest.Builder

Request message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysRequest

ListHcxActivationKeysResponse

Response message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysResponse

ListHcxActivationKeysResponse.Builder

Response message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysResponse

ListNetworkPoliciesRequest

Request message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesRequest

ListNetworkPoliciesRequest.Builder

Request message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesRequest

ListNetworkPoliciesResponse

Response message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesResponse

ListNetworkPoliciesResponse.Builder

Response message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesResponse

ListNodeTypesRequest

Request message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesRequest

ListNodeTypesRequest.Builder

Request message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesRequest

ListNodeTypesResponse

Response message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesResponse

ListNodeTypesResponse.Builder

Response message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesResponse

ListPrivateCloudsRequest

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

ListPrivateCloudsRequest.Builder

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

ListPrivateCloudsResponse

Response message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsResponse

ListPrivateCloudsResponse.Builder

Response message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsResponse

ListSubnetsRequest

Request message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsRequest

ListSubnetsRequest.Builder

Request message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsRequest

ListSubnetsResponse

Response message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsResponse

ListSubnetsResponse.Builder

Response message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsResponse

ListVmwareEngineNetworksRequest

Request message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksRequest

ListVmwareEngineNetworksRequest.Builder

Request message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksRequest

ListVmwareEngineNetworksResponse

Response message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksResponse

ListVmwareEngineNetworksResponse.Builder

Response message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

NetworkConfig

Network configuration in the consumer project with which the peering has to be done.

Protobuf type google.cloud.vmwareengine.v1.NetworkConfig

NetworkConfig.Builder

Network configuration in the consumer project with which the peering has to be done.

Protobuf type google.cloud.vmwareengine.v1.NetworkConfig

NetworkPolicy

Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy.

Protobuf type google.cloud.vmwareengine.v1.NetworkPolicy

NetworkPolicy.Builder

Protobuf type google.cloud.vmwareengine.v1.NetworkPolicy

NetworkPolicy.NetworkService

Represents a network service that is managed by a NetworkPolicy resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet.

Protobuf type google.cloud.vmwareengine.v1.NetworkPolicy.NetworkService

NetworkPolicy.NetworkService.Builder

Protobuf type google.cloud.vmwareengine.v1.NetworkPolicy.NetworkService

NetworkPolicyName

NetworkPolicyName.Builder

Builder for projects/{project}/locations/{location}/networkPolicies/{network_policy}.

NodeType

Describes node type.

Protobuf type google.cloud.vmwareengine.v1.NodeType

NodeType.Builder

Describes node type.

Protobuf type google.cloud.vmwareengine.v1.NodeType

NodeTypeConfig

Information about the type and number of nodes associated with the cluster.

Protobuf type google.cloud.vmwareengine.v1.NodeTypeConfig

NodeTypeConfig.Builder

Information about the type and number of nodes associated with the cluster.

Protobuf type google.cloud.vmwareengine.v1.NodeTypeConfig

NodeTypeName

NodeTypeName.Builder

Builder for projects/{project}/locations/{location}/nodeTypes/{node_type}.

Nsx

Details about a NSX Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Nsx

Nsx.Builder

Details about a NSX Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Nsx

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.vmwareengine.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.vmwareengine.v1.OperationMetadata

PrivateCloud

Represents a private cloud resource. Private clouds are zonal resources.

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud

PrivateCloud.Builder

Represents a private cloud resource. Private clouds are zonal resources.

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud

PrivateCloud.ManagementCluster

Management cluster configuration.

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud.ManagementCluster

PrivateCloud.ManagementCluster.Builder

Management cluster configuration.

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud.ManagementCluster

PrivateCloudName

PrivateCloudName.Builder

Builder for projects/{project}/locations/{location}/privateClouds/{private_cloud}.

ResetNsxCredentialsRequest

Request message for VmwareEngine.ResetNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetNsxCredentialsRequest

ResetNsxCredentialsRequest.Builder

Request message for VmwareEngine.ResetNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetNsxCredentialsRequest

ResetVcenterCredentialsRequest

Request message for VmwareEngine.ResetVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetVcenterCredentialsRequest

ResetVcenterCredentialsRequest.Builder

Request message for VmwareEngine.ResetVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetVcenterCredentialsRequest

ShowNsxCredentialsRequest

Request message for VmwareEngine.ShowNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowNsxCredentialsRequest

ShowNsxCredentialsRequest.Builder

Request message for VmwareEngine.ShowNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowNsxCredentialsRequest

ShowVcenterCredentialsRequest

Request message for VmwareEngine.ShowVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowVcenterCredentialsRequest

ShowVcenterCredentialsRequest.Builder

Request message for VmwareEngine.ShowVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowVcenterCredentialsRequest

Subnet

Subnet in a private cloud. Either management subnets (such as vMotion) that are read-only, or userDefined, which can also be updated.

Protobuf type google.cloud.vmwareengine.v1.Subnet

Subnet.Builder

Subnet in a private cloud. Either management subnets (such as vMotion) that are read-only, or userDefined, which can also be updated.

Protobuf type google.cloud.vmwareengine.v1.Subnet

UndeletePrivateCloudRequest

Request message for VmwareEngine.UndeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UndeletePrivateCloudRequest

UndeletePrivateCloudRequest.Builder

Request message for VmwareEngine.UndeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UndeletePrivateCloudRequest

UpdateClusterRequest

Request message for VmwareEngine.UpdateCluster

Protobuf type google.cloud.vmwareengine.v1.UpdateClusterRequest

UpdateClusterRequest.Builder

Request message for VmwareEngine.UpdateCluster

Protobuf type google.cloud.vmwareengine.v1.UpdateClusterRequest

UpdateNetworkPolicyRequest

Request message for VmwareEngine.UpdateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.UpdateNetworkPolicyRequest

UpdateNetworkPolicyRequest.Builder

Request message for VmwareEngine.UpdateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.UpdateNetworkPolicyRequest

UpdatePrivateCloudRequest

Request message for VmwareEngine.UpdatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UpdatePrivateCloudRequest

UpdatePrivateCloudRequest.Builder

Request message for VmwareEngine.UpdatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UpdatePrivateCloudRequest

UpdateVmwareEngineNetworkRequest

Request message for VmwareEngine.UpdateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.UpdateVmwareEngineNetworkRequest

UpdateVmwareEngineNetworkRequest.Builder

Request message for VmwareEngine.UpdateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.UpdateVmwareEngineNetworkRequest

Vcenter

Details about a vCenter Server management appliance.

Protobuf type google.cloud.vmwareengine.v1.Vcenter

Vcenter.Builder

Details about a vCenter Server management appliance.

Protobuf type google.cloud.vmwareengine.v1.Vcenter

VmwareEngineClient

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:

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

The default service address (vmwareengine.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getPrivateCloud to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.Builder vmwareEngineSettingsBuilder = VmwareEngineSettings.newBuilder();
 vmwareEngineSettingsBuilder
     .getPrivateCloudSettings()
     .setRetrySettings(
         vmwareEngineSettingsBuilder
             .getPrivateCloudSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VmwareEngineSettings vmwareEngineSettings = vmwareEngineSettingsBuilder.build();