VMware Engine v1 API - Class VmwareEngine.VmwareEngineBase (1.0.0) 

[BindServiceMethod(typeof(VmwareEngine), "BindService")]
public abstract class VmwareEngine.VmwareEngineBase

Reference documentation and code samples for the VMware Engine v1 API class VmwareEngine.VmwareEngineBase.

Base class for server-side implementations of VmwareEngine

Inheritance

object > VmwareEngine.VmwareEngineBase

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Methods

CreateCluster(CreateClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateCluster(CreateClusterRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateHcxActivationKey(CreateHcxActivationKeyRequest, ServerCallContext)

public virtual Task<Operation> CreateHcxActivationKey(CreateHcxActivationKeyRequest request, ServerCallContext context)

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

Parameters
Name Description
request CreateHcxActivationKeyRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateNetworkPolicy(CreateNetworkPolicyRequest, ServerCallContext)

public virtual Task<Operation> CreateNetworkPolicy(CreateNetworkPolicyRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreatePrivateCloud(CreatePrivateCloudRequest, ServerCallContext)

public virtual Task<Operation> CreatePrivateCloud(CreatePrivateCloudRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreatePrivateConnection(CreatePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> CreatePrivateConnection(CreatePrivateConnectionRequest request, ServerCallContext context)

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

Parameters
Name Description
request CreatePrivateConnectionRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateVmwareEngineNetwork(CreateVmwareEngineNetworkRequest, ServerCallContext)

public virtual Task<Operation> CreateVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request, ServerCallContext context)

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

Parameters
Name Description
request CreateVmwareEngineNetworkRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteCluster(DeleteClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteCluster(DeleteClusterRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteNetworkPolicy(DeleteNetworkPolicyRequest, ServerCallContext)

public virtual Task<Operation> DeleteNetworkPolicy(DeleteNetworkPolicyRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeletePrivateCloud(DeletePrivateCloudRequest, ServerCallContext)

public virtual Task<Operation> DeletePrivateCloud(DeletePrivateCloudRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeletePrivateConnection(DeletePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> DeletePrivateConnection(DeletePrivateConnectionRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest, ServerCallContext)

public virtual Task<Operation> DeleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetCluster(GetClusterRequest, ServerCallContext)

public virtual Task<Cluster> GetCluster(GetClusterRequest request, ServerCallContext context)

Retrieves a Cluster resource by its resource name.

Parameters
Name Description
request GetClusterRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskCluster

The response to send back to the client (wrapped by a task).

GetHcxActivationKey(GetHcxActivationKeyRequest, ServerCallContext)

public virtual Task<HcxActivationKey> GetHcxActivationKey(GetHcxActivationKeyRequest request, ServerCallContext context)

Retrieves a HcxActivationKey resource by its resource name.

Parameters
Name Description
request GetHcxActivationKeyRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskHcxActivationKey

The response to send back to the client (wrapped by a task).

GetNetworkPolicy(GetNetworkPolicyRequest, ServerCallContext)

public virtual Task<NetworkPolicy> GetNetworkPolicy(GetNetworkPolicyRequest request, ServerCallContext context)

Retrieves a NetworkPolicy resource by its resource name.

Parameters
Name Description
request GetNetworkPolicyRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskNetworkPolicy

The response to send back to the client (wrapped by a task).

GetNodeType(GetNodeTypeRequest, ServerCallContext)

public virtual Task<NodeType> GetNodeType(GetNodeTypeRequest request, ServerCallContext context)

Gets details of a single NodeType.

Parameters
Name Description
request GetNodeTypeRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskNodeType

The response to send back to the client (wrapped by a task).

GetPrivateCloud(GetPrivateCloudRequest, ServerCallContext)

public virtual Task<PrivateCloud> GetPrivateCloud(GetPrivateCloudRequest request, ServerCallContext context)

Retrieves a PrivateCloud resource by its resource name.

Parameters
Name Description
request GetPrivateCloudRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskPrivateCloud

The response to send back to the client (wrapped by a task).

GetPrivateConnection(GetPrivateConnectionRequest, ServerCallContext)

public virtual Task<PrivateConnection> GetPrivateConnection(GetPrivateConnectionRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskPrivateConnection

The response to send back to the client (wrapped by a task).

GetSubnet(GetSubnetRequest, ServerCallContext)

public virtual Task<Subnet> GetSubnet(GetSubnetRequest request, ServerCallContext context)

Gets details of a single subnet.

Parameters
Name Description
request GetSubnetRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskSubnet

The response to send back to the client (wrapped by a task).

GetVmwareEngineNetwork(GetVmwareEngineNetworkRequest, ServerCallContext)

public virtual Task<VmwareEngineNetwork> GetVmwareEngineNetwork(GetVmwareEngineNetworkRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskVmwareEngineNetwork

The response to send back to the client (wrapped by a task).

ListClusters(ListClustersRequest, ServerCallContext)

public virtual Task<ListClustersResponse> ListClusters(ListClustersRequest request, ServerCallContext context)

Lists Cluster resources in a given private cloud.

Parameters
Name Description
request ListClustersRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListClustersResponse

The response to send back to the client (wrapped by a task).

ListHcxActivationKeys(ListHcxActivationKeysRequest, ServerCallContext)

public virtual Task<ListHcxActivationKeysResponse> ListHcxActivationKeys(ListHcxActivationKeysRequest request, ServerCallContext context)

Lists HcxActivationKey resources in a given private cloud.

Parameters
Name Description
request ListHcxActivationKeysRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListHcxActivationKeysResponse

The response to send back to the client (wrapped by a task).

ListNetworkPolicies(ListNetworkPoliciesRequest, ServerCallContext)

public virtual Task<ListNetworkPoliciesResponse> ListNetworkPolicies(ListNetworkPoliciesRequest request, ServerCallContext context)

Lists NetworkPolicy resources in a specified project and location.

Parameters
Name Description
request ListNetworkPoliciesRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListNetworkPoliciesResponse

The response to send back to the client (wrapped by a task).

ListNodeTypes(ListNodeTypesRequest, ServerCallContext)

public virtual Task<ListNodeTypesResponse> ListNodeTypes(ListNodeTypesRequest request, ServerCallContext context)

Lists node types

Parameters
Name Description
request ListNodeTypesRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListNodeTypesResponse

The response to send back to the client (wrapped by a task).

ListPrivateClouds(ListPrivateCloudsRequest, ServerCallContext)

public virtual Task<ListPrivateCloudsResponse> ListPrivateClouds(ListPrivateCloudsRequest request, ServerCallContext context)

Lists PrivateCloud resources in a given project and location.

Parameters
Name Description
request ListPrivateCloudsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListPrivateCloudsResponse

The response to send back to the client (wrapped by a task).

ListPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest, ServerCallContext)

public virtual Task<ListPrivateConnectionPeeringRoutesResponse> ListPrivateConnectionPeeringRoutes(ListPrivateConnectionPeeringRoutesRequest request, ServerCallContext context)

Lists the private connection routes exchanged over a peering connection.

Parameters
Name Description
request ListPrivateConnectionPeeringRoutesRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListPrivateConnectionPeeringRoutesResponse

The response to send back to the client (wrapped by a task).

ListPrivateConnections(ListPrivateConnectionsRequest, ServerCallContext)

public virtual Task<ListPrivateConnectionsResponse> ListPrivateConnections(ListPrivateConnectionsRequest request, ServerCallContext context)

Lists PrivateConnection resources in a given project and location.

Parameters
Name Description
request ListPrivateConnectionsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListPrivateConnectionsResponse

The response to send back to the client (wrapped by a task).

ListSubnets(ListSubnetsRequest, ServerCallContext)

public virtual Task<ListSubnetsResponse> ListSubnets(ListSubnetsRequest request, ServerCallContext context)

Lists subnets in a given private cloud.

Parameters
Name Description
request ListSubnetsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListSubnetsResponse

The response to send back to the client (wrapped by a task).

ListVmwareEngineNetworks(ListVmwareEngineNetworksRequest, ServerCallContext)

public virtual Task<ListVmwareEngineNetworksResponse> ListVmwareEngineNetworks(ListVmwareEngineNetworksRequest request, ServerCallContext context)

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
Name Description
request ListVmwareEngineNetworksRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskListVmwareEngineNetworksResponse

The response to send back to the client (wrapped by a task).

ResetNsxCredentials(ResetNsxCredentialsRequest, ServerCallContext)

public virtual Task<Operation> ResetNsxCredentials(ResetNsxCredentialsRequest request, ServerCallContext context)

Resets credentials of the NSX appliance.

Parameters
Name Description
request ResetNsxCredentialsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ResetVcenterCredentials(ResetVcenterCredentialsRequest, ServerCallContext)

public virtual Task<Operation> ResetVcenterCredentials(ResetVcenterCredentialsRequest request, ServerCallContext context)

Resets credentials of the Vcenter appliance.

Parameters
Name Description
request ResetVcenterCredentialsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ShowNsxCredentials(ShowNsxCredentialsRequest, ServerCallContext)

public virtual Task<Credentials> ShowNsxCredentials(ShowNsxCredentialsRequest request, ServerCallContext context)

Gets details of credentials for NSX appliance.

Parameters
Name Description
request ShowNsxCredentialsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskCredentials

The response to send back to the client (wrapped by a task).

ShowVcenterCredentials(ShowVcenterCredentialsRequest, ServerCallContext)

public virtual Task<Credentials> ShowVcenterCredentials(ShowVcenterCredentialsRequest request, ServerCallContext context)

Gets details of credentials for Vcenter appliance.

Parameters
Name Description
request ShowVcenterCredentialsRequest

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskCredentials

The response to send back to the client (wrapped by a task).

UndeletePrivateCloud(UndeletePrivateCloudRequest, ServerCallContext)

public virtual Task<Operation> UndeletePrivateCloud(UndeletePrivateCloudRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateCluster(UpdateClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateCluster(UpdateClusterRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateNetworkPolicy(UpdateNetworkPolicyRequest, ServerCallContext)

public virtual Task<Operation> UpdateNetworkPolicy(UpdateNetworkPolicyRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdatePrivateCloud(UpdatePrivateCloudRequest, ServerCallContext)

public virtual Task<Operation> UpdatePrivateCloud(UpdatePrivateCloudRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdatePrivateConnection(UpdatePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> UpdatePrivateConnection(UpdatePrivateConnectionRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateSubnet(UpdateSubnetRequest, ServerCallContext)

public virtual Task<Operation> UpdateSubnet(UpdateSubnetRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest, ServerCallContext)

public virtual Task<Operation> UpdateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request, ServerCallContext context)

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

The request received from the client.
context ServerCallContext

The context of the server-side call handler being invoked.
Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).