Class VmwareEngineGrpc.VmwareEngineFutureStub (0.14.0)

public static final class VmwareEngineGrpc.VmwareEngineFutureStub extends AbstractFutureStub<VmwareEngineGrpc.VmwareEngineFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service VmwareEngine.

VMwareEngine manages VMware's private clusters in the Cloud.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > VmwareEngineGrpc.VmwareEngineFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected VmwareEngineGrpc.VmwareEngineFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`VmwareEngineGrpc.VmwareEngineFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createCluster(CreateClusterRequest request)

public ListenableFuture<Operation> createCluster(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.

Parameter
Name	Description
`request`	`CreateClusterRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createHcxActivationKey(CreateHcxActivationKeyRequest request)

public ListenableFuture<Operation> createHcxActivationKey(CreateHcxActivationKeyRequest request)

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

Parameter
Name	Description
`request`	`CreateHcxActivationKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createNetworkPolicy(CreateNetworkPolicyRequest request)

public ListenableFuture<Operation> createNetworkPolicy(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.

Parameter
Name	Description
`request`	`CreateNetworkPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createPrivateCloud(CreatePrivateCloudRequest request)

public ListenableFuture<Operation> createPrivateCloud(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.

Parameter
Name	Description
`request`	`CreatePrivateCloudRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createPrivateConnection(CreatePrivateConnectionRequest request)

public ListenableFuture<Operation> createPrivateConnection(CreatePrivateConnectionRequest request)

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

Parameter
Name	Description
`request`	`CreatePrivateConnectionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request)

public ListenableFuture<Operation> createVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request)

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

Parameter
Name	Description
`request`	`CreateVmwareEngineNetworkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteCluster(DeleteClusterRequest request)

public ListenableFuture<Operation> deleteCluster(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.

Parameter
Name	Description
`request`	`DeleteClusterRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteNetworkPolicy(DeleteNetworkPolicyRequest request)

public ListenableFuture<Operation> deleteNetworkPolicy(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.

Parameter
Name	Description
`request`	`DeleteNetworkPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deletePrivateCloud(DeletePrivateCloudRequest request)

public ListenableFuture<Operation> deletePrivateCloud(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.

Parameter
Name	Description
`request`	`DeletePrivateCloudRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deletePrivateConnection(DeletePrivateConnectionRequest request)

public ListenableFuture<Operation> deletePrivateConnection(DeletePrivateConnectionRequest request)

Deletes a PrivateConnection resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.

Parameter
Name	Description
`request`	`DeletePrivateConnectionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest request)

public ListenableFuture<Operation> deleteVmwareEngineNetwork(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.

Parameter
Name	Description
`request`	`DeleteVmwareEngineNetworkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getCluster(GetClusterRequest request)

public ListenableFuture<Cluster> getCluster(GetClusterRequest request)

Retrieves a Cluster resource by its resource name.

Parameter
Name	Description
`request`	`GetClusterRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Cluster>`

getHcxActivationKey(GetHcxActivationKeyRequest request)

public ListenableFuture<HcxActivationKey> getHcxActivationKey(GetHcxActivationKeyRequest request)

Retrieves a HcxActivationKey resource by its resource name.

Parameter
Name	Description
`request`	`GetHcxActivationKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<HcxActivationKey>`

getNetworkPolicy(GetNetworkPolicyRequest request)

public ListenableFuture<NetworkPolicy> getNetworkPolicy(GetNetworkPolicyRequest request)

Retrieves a NetworkPolicy resource by its resource name.

Parameter
Name	Description
`request`	`GetNetworkPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<NetworkPolicy>`

getNodeType(GetNodeTypeRequest request)

public ListenableFuture<NodeType> getNodeType(GetNodeTypeRequest request)

Gets details of a single NodeType.

Parameter
Name	Description
`request`	`GetNodeTypeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<NodeType>`

getPrivateCloud(GetPrivateCloudRequest request)

public ListenableFuture<PrivateCloud> getPrivateCloud(GetPrivateCloudRequest request)

Retrieves a PrivateCloud resource by its resource name.

Parameter
Name	Description
`request`	`GetPrivateCloudRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PrivateCloud>`

getPrivateConnection(GetPrivateConnectionRequest request)

public ListenableFuture<PrivateConnection> getPrivateConnection(GetPrivateConnectionRequest request)

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

Parameter
Name	Description
`request`	`GetPrivateConnectionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PrivateConnection>`

getSubnet(GetSubnetRequest request)

public ListenableFuture<Subnet> getSubnet(GetSubnetRequest request)

Gets details of a single subnet.

Parameter
Name	Description
`request`	`GetSubnetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Subnet>`

getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request)

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

Parameter
Name	Description
`request`	`GetVmwareEngineNetworkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<VmwareEngineNetwork>`

listClusters(ListClustersRequest request)

public ListenableFuture<ListClustersResponse> listClusters(ListClustersRequest request)

Lists Cluster resources in a given private cloud.

Parameter
Name	Description
`request`	`ListClustersRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListClustersResponse>`

listHcxActivationKeys(ListHcxActivationKeysRequest request)

public ListenableFuture<ListHcxActivationKeysResponse> listHcxActivationKeys(ListHcxActivationKeysRequest request)

Lists HcxActivationKey resources in a given private cloud.

Parameter
Name	Description
`request`	`ListHcxActivationKeysRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListHcxActivationKeysResponse>`

listNetworkPolicies(ListNetworkPoliciesRequest request)

public ListenableFuture<ListNetworkPoliciesResponse> listNetworkPolicies(ListNetworkPoliciesRequest request)

Lists NetworkPolicy resources in a specified project and location.

Parameter
Name	Description
`request`	`ListNetworkPoliciesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListNetworkPoliciesResponse>`

listNodeTypes(ListNodeTypesRequest request)

public ListenableFuture<ListNodeTypesResponse> listNodeTypes(ListNodeTypesRequest request)

Lists node types

Parameter
Name	Description
`request`	`ListNodeTypesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListNodeTypesResponse>`

listPrivateClouds(ListPrivateCloudsRequest request)

public ListenableFuture<ListPrivateCloudsResponse> listPrivateClouds(ListPrivateCloudsRequest request)

Lists PrivateCloud resources in a given project and location.

Parameter
Name	Description
`request`	`ListPrivateCloudsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListPrivateCloudsResponse>`

listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request)

public ListenableFuture<ListPrivateConnectionPeeringRoutesResponse> listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request)

Lists the private connection routes exchanged over a peering connection.

Parameter
Name	Description
`request`	`ListPrivateConnectionPeeringRoutesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListPrivateConnectionPeeringRoutesResponse>`

listPrivateConnections(ListPrivateConnectionsRequest request)

public ListenableFuture<ListPrivateConnectionsResponse> listPrivateConnections(ListPrivateConnectionsRequest request)

Lists PrivateConnection resources in a given project and location.

Parameter
Name	Description
`request`	`ListPrivateConnectionsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListPrivateConnectionsResponse>`

listSubnets(ListSubnetsRequest request)

public ListenableFuture<ListSubnetsResponse> listSubnets(ListSubnetsRequest request)

Lists subnets in a given private cloud.

Parameter
Name	Description
`request`	`ListSubnetsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListSubnetsResponse>`

listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request)

public ListenableFuture<ListVmwareEngineNetworksResponse> listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request)

Lists VmwareEngineNetwork resources in a given project and location.

Parameter
Name	Description
`request`	`ListVmwareEngineNetworksRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListVmwareEngineNetworksResponse>`

resetNsxCredentials(ResetNsxCredentialsRequest request)

public ListenableFuture<Operation> resetNsxCredentials(ResetNsxCredentialsRequest request)

Resets credentials of the NSX appliance.

Parameter
Name	Description
`request`	`ResetNsxCredentialsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

resetVcenterCredentials(ResetVcenterCredentialsRequest request)

public ListenableFuture<Operation> resetVcenterCredentials(ResetVcenterCredentialsRequest request)

Resets credentials of the Vcenter appliance.

Parameter
Name	Description
`request`	`ResetVcenterCredentialsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

showNsxCredentials(ShowNsxCredentialsRequest request)

public ListenableFuture<Credentials> showNsxCredentials(ShowNsxCredentialsRequest request)

Gets details of credentials for NSX appliance.

Parameter
Name	Description
`request`	`ShowNsxCredentialsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Credentials>`

showVcenterCredentials(ShowVcenterCredentialsRequest request)

public ListenableFuture<Credentials> showVcenterCredentials(ShowVcenterCredentialsRequest request)

Gets details of credentials for Vcenter appliance.

Parameter
Name	Description
`request`	`ShowVcenterCredentialsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Credentials>`

undeletePrivateCloud(UndeletePrivateCloudRequest request)

public ListenableFuture<Operation> undeletePrivateCloud(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.

Parameter
Name	Description
`request`	`UndeletePrivateCloudRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateCluster(UpdateClusterRequest request)

public ListenableFuture<Operation> updateCluster(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.

Parameter
Name	Description
`request`	`UpdateClusterRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateNetworkPolicy(UpdateNetworkPolicyRequest request)

public ListenableFuture<Operation> updateNetworkPolicy(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.

Parameter
Name	Description
`request`	`UpdateNetworkPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updatePrivateCloud(UpdatePrivateCloudRequest request)

public ListenableFuture<Operation> updatePrivateCloud(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.

Parameter
Name	Description
`request`	`UpdatePrivateCloudRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updatePrivateConnection(UpdatePrivateConnectionRequest request)

public ListenableFuture<Operation> updatePrivateConnection(UpdatePrivateConnectionRequest request)

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

Parameter
Name	Description
`request`	`UpdatePrivateConnectionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateSubnet(UpdateSubnetRequest request)

public ListenableFuture<Operation> updateSubnet(UpdateSubnetRequest request)

Updates the parameters of a single subnet. Only fields specified in update_mask are applied. Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

Parameter
Name	Description
`request`	`UpdateSubnetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request)

public ListenableFuture<Operation> updateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request)

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

Parameter
Name	Description
`request`	`UpdateVmwareEngineNetworkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`