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

A cluster in a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Cluster

A cluster in a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Cluster

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

Request message for VmwareEngine.CreateCluster

Protobuf type google.cloud.vmwareengine.v1.CreateClusterRequest

Request message for VmwareEngine.CreateCluster

Protobuf type google.cloud.vmwareengine.v1.CreateClusterRequest

Request message for VmwareEngine.CreateHcxActivationKey

Protobuf type google.cloud.vmwareengine.v1.CreateHcxActivationKeyRequest

Request message for VmwareEngine.CreateHcxActivationKey

Protobuf type google.cloud.vmwareengine.v1.CreateHcxActivationKeyRequest

Request message for VmwareEngine.CreateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.CreateNetworkPolicyRequest

Request message for VmwareEngine.CreateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.CreateNetworkPolicyRequest

Request message for VmwareEngine.CreatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.CreatePrivateCloudRequest

Request message for VmwareEngine.CreatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.CreatePrivateCloudRequest

Request message for VmwareEngine.CreateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.CreateVmwareEngineNetworkRequest

Request message for VmwareEngine.CreateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.CreateVmwareEngineNetworkRequest

Credentials for a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Credentials

Credentials for a private cloud.

Protobuf type google.cloud.vmwareengine.v1.Credentials

Request message for VmwareEngine.DeleteCluster

Protobuf type google.cloud.vmwareengine.v1.DeleteClusterRequest

Request message for VmwareEngine.DeleteCluster

Protobuf type google.cloud.vmwareengine.v1.DeleteClusterRequest

Request message for VmwareEngine.DeleteNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.DeleteNetworkPolicyRequest

Request message for VmwareEngine.DeleteNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.DeleteNetworkPolicyRequest

Request message for VmwareEngine.DeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.DeletePrivateCloudRequest

Request message for VmwareEngine.DeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.DeletePrivateCloudRequest

Request message for VmwareEngine.DeleteVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.DeleteVmwareEngineNetworkRequest

Request message for VmwareEngine.DeleteVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.DeleteVmwareEngineNetworkRequest

Request message for VmwareEngine.GetCluster

Protobuf type google.cloud.vmwareengine.v1.GetClusterRequest

Request message for VmwareEngine.GetCluster

Protobuf type google.cloud.vmwareengine.v1.GetClusterRequest

Request message for [VmwareEngine.GetHcxActivationKeys][]

Protobuf type google.cloud.vmwareengine.v1.GetHcxActivationKeyRequest

Request message for [VmwareEngine.GetHcxActivationKeys][]

Protobuf type google.cloud.vmwareengine.v1.GetHcxActivationKeyRequest

Request message for VmwareEngine.GetNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.GetNetworkPolicyRequest

Request message for VmwareEngine.GetNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.GetNetworkPolicyRequest

Request message for VmwareEngine.GetNodeType

Protobuf type google.cloud.vmwareengine.v1.GetNodeTypeRequest

Request message for VmwareEngine.GetNodeType

Protobuf type google.cloud.vmwareengine.v1.GetNodeTypeRequest

Request message for VmwareEngine.GetPrivateCloud

Protobuf type google.cloud.vmwareengine.v1.GetPrivateCloudRequest

Request message for VmwareEngine.GetPrivateCloud

Protobuf type google.cloud.vmwareengine.v1.GetPrivateCloudRequest

Request message for VmwareEngine.GetVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.GetVmwareEngineNetworkRequest

Request message for VmwareEngine.GetVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.GetVmwareEngineNetworkRequest

Details about a HCX Cloud Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Hcx

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

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

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

Request message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersRequest

Request message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersRequest

Response message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersResponse

Response message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersResponse

Request message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysRequest

Request message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysRequest

Response message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysResponse

Response message for VmwareEngine.ListHcxActivationKeys

Protobuf type google.cloud.vmwareengine.v1.ListHcxActivationKeysResponse

Request message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesRequest

Request message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesRequest

Response message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesResponse

Response message for VmwareEngine.ListNetworkPolicies

Protobuf type google.cloud.vmwareengine.v1.ListNetworkPoliciesResponse

Request message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesRequest

Request message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesRequest

Response message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesResponse

Response message for VmwareEngine.ListNodeTypes

Protobuf type google.cloud.vmwareengine.v1.ListNodeTypesResponse

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

Response message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsResponse

Response message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsResponse

Request message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsRequest

Request message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsRequest

Response message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsResponse

Response message for VmwareEngine.ListSubnets

Protobuf type google.cloud.vmwareengine.v1.ListSubnetsResponse

Request message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksRequest

Request message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksRequest

Response message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksResponse

Response message for VmwareEngine.ListVmwareEngineNetworks

Protobuf type google.cloud.vmwareengine.v1.ListVmwareEngineNetworksResponse

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

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

Protobuf type google.cloud.vmwareengine.v1.NetworkConfig

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

Protobuf type google.cloud.vmwareengine.v1.NetworkConfig

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

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

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

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

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

Describes node type.

Protobuf type google.cloud.vmwareengine.v1.NodeType

Describes node type.

Protobuf type google.cloud.vmwareengine.v1.NodeType

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

Protobuf type google.cloud.vmwareengine.v1.NodeTypeConfig

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

Protobuf type google.cloud.vmwareengine.v1.NodeTypeConfig

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

Details about a NSX Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Nsx

Details about a NSX Manager appliance.

Protobuf type google.cloud.vmwareengine.v1.Nsx

Represents the metadata of the long-running operation.

Protobuf type google.cloud.vmwareengine.v1.OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.vmwareengine.v1.OperationMetadata

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

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud

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

Protobuf type google.cloud.vmwareengine.v1.PrivateCloud

Management cluster configuration.

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

Management cluster configuration.

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

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

Request message for VmwareEngine.ResetNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetNsxCredentialsRequest

Request message for VmwareEngine.ResetNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetNsxCredentialsRequest

Request message for VmwareEngine.ResetVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetVcenterCredentialsRequest

Request message for VmwareEngine.ResetVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ResetVcenterCredentialsRequest

Request message for VmwareEngine.ShowNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowNsxCredentialsRequest

Request message for VmwareEngine.ShowNsxCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowNsxCredentialsRequest

Request message for VmwareEngine.ShowVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowVcenterCredentialsRequest

Request message for VmwareEngine.ShowVcenterCredentials

Protobuf type google.cloud.vmwareengine.v1.ShowVcenterCredentialsRequest

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

Request message for VmwareEngine.UndeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UndeletePrivateCloudRequest

Request message for VmwareEngine.UndeletePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UndeletePrivateCloudRequest

Request message for VmwareEngine.UpdateCluster

Protobuf type google.cloud.vmwareengine.v1.UpdateClusterRequest

Request message for VmwareEngine.UpdateCluster

Protobuf type google.cloud.vmwareengine.v1.UpdateClusterRequest

Request message for VmwareEngine.UpdateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.UpdateNetworkPolicyRequest

Request message for VmwareEngine.UpdateNetworkPolicy

Protobuf type google.cloud.vmwareengine.v1.UpdateNetworkPolicyRequest

Request message for VmwareEngine.UpdatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UpdatePrivateCloudRequest

Request message for VmwareEngine.UpdatePrivateCloud

Protobuf type google.cloud.vmwareengine.v1.UpdatePrivateCloudRequest

Request message for VmwareEngine.UpdateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.UpdateVmwareEngineNetworkRequest

Request message for VmwareEngine.UpdateVmwareEngineNetwork

Protobuf type google.cloud.vmwareengine.v1.UpdateVmwareEngineNetworkRequest

Details about a vCenter Server management appliance.

Protobuf type google.cloud.vmwareengine.v1.Vcenter

Details about a vCenter Server management appliance.

Protobuf type google.cloud.vmwareengine.v1.Vcenter

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.

VMwareEngine manages VMware's private clusters in the Cloud.

VMwareEngine manages VMware's private clusters in the Cloud.

VMwareEngine manages VMware's private clusters in the Cloud.

VMwareEngine manages VMware's private clusters in the Cloud.

VMwareEngine manages VMware's private clusters in the Cloud.

VMware Engine network resource that provides connectivity for VMware Engine private clouds.

Protobuf type google.cloud.vmwareengine.v1.VmwareEngineNetwork

VMware Engine network resource that provides connectivity for VMware Engine private clouds.

Protobuf type google.cloud.vmwareengine.v1.VmwareEngineNetwork

Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.

Protobuf type google.cloud.vmwareengine.v1.VmwareEngineNetwork.VpcNetwork

Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.

Protobuf type google.cloud.vmwareengine.v1.VmwareEngineNetwork.VpcNetwork

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

Settings class to configure an instance of VmwareEngineClient.

The default instance has everything set to sensible defaults:

• 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();
 

Builder for VmwareEngineSettings.

Enum State defines possible states of private cloud clusters.

Protobuf enum google.cloud.vmwareengine.v1.Cluster.State

State of the appliance

Protobuf enum google.cloud.vmwareengine.v1.Hcx.State

State of HCX activation key

Protobuf enum google.cloud.vmwareengine.v1.HcxActivationKey.State

Enum State defines possible states of a network policy controlled service.

Protobuf enum google.cloud.vmwareengine.v1.NetworkPolicy.NetworkService.State

State of the appliance

Protobuf enum google.cloud.vmwareengine.v1.Nsx.State

Enum State defines possible states of private clouds.

Protobuf enum google.cloud.vmwareengine.v1.PrivateCloud.State

Defines possible states of subnets.

Protobuf enum google.cloud.vmwareengine.v1.Subnet.State

State of the appliance

Protobuf enum google.cloud.vmwareengine.v1.Vcenter.State

Enum State defines possible states of VMware Engine network.

Protobuf enum google.cloud.vmwareengine.v1.VmwareEngineNetwork.State

Enum Type defines possible types of VMware Engine network.

Protobuf enum google.cloud.vmwareengine.v1.VmwareEngineNetwork.Type

Enum Type defines possible types of a VMware Engine network controlled service.

Protobuf enum google.cloud.vmwareengine.v1.VmwareEngineNetwork.VpcNetwork.Type