- 0.72.0 (latest)
- 0.70.0
- 0.69.0
- 0.68.0
- 0.67.0
- 0.66.0
- 0.64.0
- 0.62.0
- 0.61.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.3.0
- 0.2.0
- 0.1.0
public static interface VmwareEngineGrpc.AsyncServiceVMwareEngine manages VMware's private clusters in the Cloud.
Methods
createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)
public default void createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateClusterRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createHcxActivationKey(CreateHcxActivationKeyRequest request, StreamObserver<Operation> responseObserver)
public default void createHcxActivationKey(CreateHcxActivationKeyRequest request, StreamObserver<Operation> responseObserver)Creates a new HCX activation key in a given private cloud.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateHcxActivationKeyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createNetworkPolicy(CreateNetworkPolicyRequest request, StreamObserver<Operation> responseObserver)
public default void createNetworkPolicy(CreateNetworkPolicyRequest request, StreamObserver<Operation> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateNetworkPolicyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createPrivateCloud(CreatePrivateCloudRequest request, StreamObserver<Operation> responseObserver)
public default void createPrivateCloud(CreatePrivateCloudRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePrivateCloudRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createPrivateConnection(CreatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)
public default void createPrivateConnection(CreatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)Creates a new private connection that can be used for accessing private Clouds.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePrivateConnectionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver)
public default void createVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver)Creates a new VMware Engine network that can be used by a private cloud.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateVmwareEngineNetworkRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver)
public default void deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deleteNetworkPolicy(DeleteNetworkPolicyRequest request, StreamObserver<Operation> responseObserver)
public default void deleteNetworkPolicy(DeleteNetworkPolicyRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteNetworkPolicyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deletePrivateCloud(DeletePrivateCloudRequest request, StreamObserver<Operation> responseObserver)
public default void deletePrivateCloud(DeletePrivateCloudRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePrivateCloudRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deletePrivateConnection(DeletePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)
public default void deletePrivateConnection(DeletePrivateConnectionRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePrivateConnectionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
deleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver)
public default void deleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteVmwareEngineNetworkRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)
public default void getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver) Retrieves a Cluster resource by its resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequest |
responseObserver |
io.grpc.stub.StreamObserver<Cluster> |
getHcxActivationKey(GetHcxActivationKeyRequest request, StreamObserver<HcxActivationKey> responseObserver)
public default void getHcxActivationKey(GetHcxActivationKeyRequest request, StreamObserver<HcxActivationKey> responseObserver) Retrieves a HcxActivationKey resource by its resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetHcxActivationKeyRequest |
responseObserver |
io.grpc.stub.StreamObserver<HcxActivationKey> |
getNetworkPolicy(GetNetworkPolicyRequest request, StreamObserver<NetworkPolicy> responseObserver)
public default void getNetworkPolicy(GetNetworkPolicyRequest request, StreamObserver<NetworkPolicy> responseObserver) Retrieves a NetworkPolicy resource by its resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNetworkPolicyRequest |
responseObserver |
io.grpc.stub.StreamObserver<NetworkPolicy> |
getNodeType(GetNodeTypeRequest request, StreamObserver<NodeType> responseObserver)
public default void getNodeType(GetNodeTypeRequest request, StreamObserver<NodeType> responseObserver) Gets details of a single NodeType.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNodeTypeRequest |
responseObserver |
io.grpc.stub.StreamObserver<NodeType> |
getPrivateCloud(GetPrivateCloudRequest request, StreamObserver<PrivateCloud> responseObserver)
public default void getPrivateCloud(GetPrivateCloudRequest request, StreamObserver<PrivateCloud> responseObserver) Retrieves a PrivateCloud resource by its resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPrivateCloudRequest |
responseObserver |
io.grpc.stub.StreamObserver<PrivateCloud> |
getPrivateConnection(GetPrivateConnectionRequest request, StreamObserver<PrivateConnection> responseObserver)
public default void getPrivateConnection(GetPrivateConnectionRequest request, StreamObserver<PrivateConnection> responseObserver) Retrieves a PrivateConnection resource by its resource name. The resource
contains details of the private connection, such as connected
network, routing mode and state.
| Parameters | |
|---|---|
| Name | Description |
request |
GetPrivateConnectionRequest |
responseObserver |
io.grpc.stub.StreamObserver<PrivateConnection> |
getSubnet(GetSubnetRequest request, StreamObserver<Subnet> responseObserver)
public default void getSubnet(GetSubnetRequest request, StreamObserver<Subnet> responseObserver)Gets details of a single subnet.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSubnetRequest |
responseObserver |
io.grpc.stub.StreamObserver<Subnet> |
getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request, StreamObserver<VmwareEngineNetwork> responseObserver)
public default void getVmwareEngineNetwork(GetVmwareEngineNetworkRequest request, StreamObserver<VmwareEngineNetwork> responseObserver) 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).
| Parameters | |
|---|---|
| Name | Description |
request |
GetVmwareEngineNetworkRequest |
responseObserver |
io.grpc.stub.StreamObserver<VmwareEngineNetwork> |
listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)
public default void listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver) Lists Cluster resources in a given private cloud.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListClustersResponse> |
listHcxActivationKeys(ListHcxActivationKeysRequest request, StreamObserver<ListHcxActivationKeysResponse> responseObserver)
public default void listHcxActivationKeys(ListHcxActivationKeysRequest request, StreamObserver<ListHcxActivationKeysResponse> responseObserver) Lists HcxActivationKey resources in a given private cloud.
| Parameters | |
|---|---|
| Name | Description |
request |
ListHcxActivationKeysRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListHcxActivationKeysResponse> |
listNetworkPolicies(ListNetworkPoliciesRequest request, StreamObserver<ListNetworkPoliciesResponse> responseObserver)
public default void listNetworkPolicies(ListNetworkPoliciesRequest request, StreamObserver<ListNetworkPoliciesResponse> responseObserver) Lists NetworkPolicy resources in a specified project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListNetworkPoliciesRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListNetworkPoliciesResponse> |
listNodeTypes(ListNodeTypesRequest request, StreamObserver<ListNodeTypesResponse> responseObserver)
public default void listNodeTypes(ListNodeTypesRequest request, StreamObserver<ListNodeTypesResponse> responseObserver)Lists node types
| Parameters | |
|---|---|
| Name | Description |
request |
ListNodeTypesRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListNodeTypesResponse> |
listPrivateClouds(ListPrivateCloudsRequest request, StreamObserver<ListPrivateCloudsResponse> responseObserver)
public default void listPrivateClouds(ListPrivateCloudsRequest request, StreamObserver<ListPrivateCloudsResponse> responseObserver) Lists PrivateCloud resources in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPrivateCloudsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListPrivateCloudsResponse> |
listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request, StreamObserver<ListPrivateConnectionPeeringRoutesResponse> responseObserver)
public default void listPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request, StreamObserver<ListPrivateConnectionPeeringRoutesResponse> responseObserver)Lists the private connection routes exchanged over a peering connection.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPrivateConnectionPeeringRoutesRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListPrivateConnectionPeeringRoutesResponse> |
listPrivateConnections(ListPrivateConnectionsRequest request, StreamObserver<ListPrivateConnectionsResponse> responseObserver)
public default void listPrivateConnections(ListPrivateConnectionsRequest request, StreamObserver<ListPrivateConnectionsResponse> responseObserver) Lists PrivateConnection resources in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPrivateConnectionsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListPrivateConnectionsResponse> |
listSubnets(ListSubnetsRequest request, StreamObserver<ListSubnetsResponse> responseObserver)
public default void listSubnets(ListSubnetsRequest request, StreamObserver<ListSubnetsResponse> responseObserver)Lists subnets in a given private cloud.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSubnetsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListSubnetsResponse> |
listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request, StreamObserver<ListVmwareEngineNetworksResponse> responseObserver)
public default void listVmwareEngineNetworks(ListVmwareEngineNetworksRequest request, StreamObserver<ListVmwareEngineNetworksResponse> responseObserver) Lists VmwareEngineNetwork resources in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListVmwareEngineNetworksRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListVmwareEngineNetworksResponse> |
resetNsxCredentials(ResetNsxCredentialsRequest request, StreamObserver<Operation> responseObserver)
public default void resetNsxCredentials(ResetNsxCredentialsRequest request, StreamObserver<Operation> responseObserver)Resets credentials of the NSX appliance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetNsxCredentialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
resetVcenterCredentials(ResetVcenterCredentialsRequest request, StreamObserver<Operation> responseObserver)
public default void resetVcenterCredentials(ResetVcenterCredentialsRequest request, StreamObserver<Operation> responseObserver)Resets credentials of the Vcenter appliance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetVcenterCredentialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
showNsxCredentials(ShowNsxCredentialsRequest request, StreamObserver<Credentials> responseObserver)
public default void showNsxCredentials(ShowNsxCredentialsRequest request, StreamObserver<Credentials> responseObserver)Gets details of credentials for NSX appliance.
| Parameters | |
|---|---|
| Name | Description |
request |
ShowNsxCredentialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Credentials> |
showVcenterCredentials(ShowVcenterCredentialsRequest request, StreamObserver<Credentials> responseObserver)
public default void showVcenterCredentials(ShowVcenterCredentialsRequest request, StreamObserver<Credentials> responseObserver)Gets details of credentials for Vcenter appliance.
| Parameters | |
|---|---|
| Name | Description |
request |
ShowVcenterCredentialsRequest |
responseObserver |
io.grpc.stub.StreamObserver<Credentials> |
undeletePrivateCloud(UndeletePrivateCloudRequest request, StreamObserver<Operation> responseObserver)
public default void undeletePrivateCloud(UndeletePrivateCloudRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeletePrivateCloudRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver)
public default void updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateClusterRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateNetworkPolicy(UpdateNetworkPolicyRequest request, StreamObserver<Operation> responseObserver)
public default void updateNetworkPolicy(UpdateNetworkPolicyRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateNetworkPolicyRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updatePrivateCloud(UpdatePrivateCloudRequest request, StreamObserver<Operation> responseObserver)
public default void updatePrivateCloud(UpdatePrivateCloudRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePrivateCloudRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updatePrivateConnection(UpdatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)
public default void updatePrivateConnection(UpdatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver) Modifies a PrivateConnection resource. Only description and
routing_mode fields can be updated. Only fields specified in updateMask
are applied.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdatePrivateConnectionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateSubnet(UpdateSubnetRequest request, StreamObserver<Operation> responseObserver)
public default void updateSubnet(UpdateSubnetRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSubnetRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
updateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver)
public default void updateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request, StreamObserver<Operation> responseObserver) Modifies a VMware Engine network resource. Only the following fields can be
updated: description. Only fields specified in updateMask are
applied.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateVmwareEngineNetworkRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |