VMware Engine v1 API - Class VmwareEngineClientImpl (1.0.0-beta02) 

public sealed class VmwareEngineClientImpl : VmwareEngineClient

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

VmwareEngine client wrapper implementation, for convenient use.

Inheritance

Object > VmwareEngineClient > VmwareEngineClientImpl

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Remarks

VMwareEngine manages VMware's private clusters in the Cloud.

Constructors

VmwareEngineClientImpl(VmwareEngine.VmwareEngineClient, VmwareEngineSettings, ILogger)

public VmwareEngineClientImpl(VmwareEngine.VmwareEngineClient grpcClient, VmwareEngineSettings settings, ILogger logger)

Constructs a client wrapper for the VmwareEngine service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientVmwareEngine.VmwareEngineClient

The underlying gRPC client.

settingsVmwareEngineSettings

The base VmwareEngineSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
TypeDescription
OperationsClient
Overrides

CreateHcxActivationKeyOperationsClient

public override OperationsClient CreateHcxActivationKeyOperationsClient { get; }

The long-running operations client for CreateHcxActivationKey.

Property Value
TypeDescription
OperationsClient
Overrides

CreateNetworkPolicyOperationsClient

public override OperationsClient CreateNetworkPolicyOperationsClient { get; }

The long-running operations client for CreateNetworkPolicy.

Property Value
TypeDescription
OperationsClient
Overrides

CreatePrivateCloudOperationsClient

public override OperationsClient CreatePrivateCloudOperationsClient { get; }

The long-running operations client for CreatePrivateCloud.

Property Value
TypeDescription
OperationsClient
Overrides

CreateVmwareEngineNetworkOperationsClient

public override OperationsClient CreateVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for CreateVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteNetworkPolicyOperationsClient

public override OperationsClient DeleteNetworkPolicyOperationsClient { get; }

The long-running operations client for DeleteNetworkPolicy.

Property Value
TypeDescription
OperationsClient
Overrides

DeletePrivateCloudOperationsClient

public override OperationsClient DeletePrivateCloudOperationsClient { get; }

The long-running operations client for DeletePrivateCloud.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteVmwareEngineNetworkOperationsClient

public override OperationsClient DeleteVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for DeleteVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override VmwareEngine.VmwareEngineClient GrpcClient { get; }

The underlying gRPC VmwareEngine client

Property Value
TypeDescription
VmwareEngine.VmwareEngineClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

ResetNsxCredentialsOperationsClient

public override OperationsClient ResetNsxCredentialsOperationsClient { get; }

The long-running operations client for ResetNsxCredentials.

Property Value
TypeDescription
OperationsClient
Overrides

ResetVcenterCredentialsOperationsClient

public override OperationsClient ResetVcenterCredentialsOperationsClient { get; }

The long-running operations client for ResetVcenterCredentials.

Property Value
TypeDescription
OperationsClient
Overrides

UndeletePrivateCloudOperationsClient

public override OperationsClient UndeletePrivateCloudOperationsClient { get; }

The long-running operations client for UndeletePrivateCloud.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateNetworkPolicyOperationsClient

public override OperationsClient UpdateNetworkPolicyOperationsClient { get; }

The long-running operations client for UpdateNetworkPolicy.

Property Value
TypeDescription
OperationsClient
Overrides

UpdatePrivateCloudOperationsClient

public override OperationsClient UpdatePrivateCloudOperationsClient { get; }

The long-running operations client for UpdatePrivateCloud.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateVmwareEngineNetworkOperationsClient

public override OperationsClient UpdateVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for UpdateVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Cluster, OperationMetadata>

The RPC response.

Overrides

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override async Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Overrides

CreateHcxActivationKey(CreateHcxActivationKeyRequest, CallSettings)

public override Operation<HcxActivationKey, OperationMetadata> CreateHcxActivationKey(CreateHcxActivationKeyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<HcxActivationKey, OperationMetadata>

The RPC response.

Overrides

CreateHcxActivationKeyAsync(CreateHcxActivationKeyRequest, CallSettings)

public override async Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(CreateHcxActivationKeyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Overrides

CreateNetworkPolicy(CreateNetworkPolicyRequest, CallSettings)

public override Operation<NetworkPolicy, OperationMetadata> CreateNetworkPolicy(CreateNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<NetworkPolicy, OperationMetadata>

The RPC response.

Overrides

CreateNetworkPolicyAsync(CreateNetworkPolicyRequest, CallSettings)

public override async Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(CreateNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Overrides

CreatePrivateCloud(CreatePrivateCloudRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> CreatePrivateCloud(CreatePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

CreatePrivateCloudAsync(CreatePrivateCloudRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> CreatePrivateCloudAsync(CreatePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

CreateVmwareEngineNetwork(CreateVmwareEngineNetworkRequest, CallSettings)

public override Operation<VmwareEngineNetwork, OperationMetadata> CreateVmwareEngineNetwork(CreateVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<VmwareEngineNetwork, OperationMetadata>

The RPC response.

Overrides

CreateVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest, CallSettings)

public override async Task<Operation<VmwareEngineNetwork, OperationMetadata>> CreateVmwareEngineNetworkAsync(CreateVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<VmwareEngineNetwork, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteCluster(DeleteClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteNetworkPolicy(DeleteNetworkPolicyRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteNetworkPolicy(DeleteNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteNetworkPolicyAsync(DeleteNetworkPolicyRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadata>> DeleteNetworkPolicyAsync(DeleteNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeletePrivateCloud(DeletePrivateCloudRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> DeletePrivateCloud(DeletePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

DeletePrivateCloudAsync(DeletePrivateCloudRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> DeletePrivateCloudAsync(DeletePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteVmwareEngineNetwork(DeleteVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadata>> DeleteVmwareEngineNetworkAsync(DeleteVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Retrieves a Cluster resource by its resource name.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Overrides

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Retrieves a Cluster resource by its resource name.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Cluster>

A Task containing the RPC response.

Overrides

GetHcxActivationKey(GetHcxActivationKeyRequest, CallSettings)

public override HcxActivationKey GetHcxActivationKey(GetHcxActivationKeyRequest request, CallSettings callSettings = null)

Retrieves a HcxActivationKey resource by its resource name.

Parameters
NameDescription
requestGetHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
HcxActivationKey

The RPC response.

Overrides

GetHcxActivationKeyAsync(GetHcxActivationKeyRequest, CallSettings)

public override Task<HcxActivationKey> GetHcxActivationKeyAsync(GetHcxActivationKeyRequest request, CallSettings callSettings = null)

Retrieves a HcxActivationKey resource by its resource name.

Parameters
NameDescription
requestGetHcxActivationKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<HcxActivationKey>

A Task containing the RPC response.

Overrides

GetNetworkPolicy(GetNetworkPolicyRequest, CallSettings)

public override NetworkPolicy GetNetworkPolicy(GetNetworkPolicyRequest request, CallSettings callSettings = null)

Retrieves a NetworkPolicy resource by its resource name.

Parameters
NameDescription
requestGetNetworkPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NetworkPolicy

The RPC response.

Overrides

GetNetworkPolicyAsync(GetNetworkPolicyRequest, CallSettings)

public override Task<NetworkPolicy> GetNetworkPolicyAsync(GetNetworkPolicyRequest request, CallSettings callSettings = null)

Retrieves a NetworkPolicy resource by its resource name.

Parameters
NameDescription
requestGetNetworkPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NetworkPolicy>

A Task containing the RPC response.

Overrides

GetNodeType(GetNodeTypeRequest, CallSettings)

public override NodeType GetNodeType(GetNodeTypeRequest request, CallSettings callSettings = null)

Gets details of a single NodeType.

Parameters
NameDescription
requestGetNodeTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NodeType

The RPC response.

Overrides

GetNodeTypeAsync(GetNodeTypeRequest, CallSettings)

public override Task<NodeType> GetNodeTypeAsync(GetNodeTypeRequest request, CallSettings callSettings = null)

Gets details of a single NodeType.

Parameters
NameDescription
requestGetNodeTypeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NodeType>

A Task containing the RPC response.

Overrides

GetPrivateCloud(GetPrivateCloudRequest, CallSettings)

public override PrivateCloud GetPrivateCloud(GetPrivateCloudRequest request, CallSettings callSettings = null)

Retrieves a PrivateCloud resource by its resource name.

Parameters
NameDescription
requestGetPrivateCloudRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PrivateCloud

The RPC response.

Overrides

GetPrivateCloudAsync(GetPrivateCloudRequest, CallSettings)

public override Task<PrivateCloud> GetPrivateCloudAsync(GetPrivateCloudRequest request, CallSettings callSettings = null)

Retrieves a PrivateCloud resource by its resource name.

Parameters
NameDescription
requestGetPrivateCloudRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PrivateCloud>

A Task containing the RPC response.

Overrides

GetVmwareEngineNetwork(GetVmwareEngineNetworkRequest, CallSettings)

public override VmwareEngineNetwork GetVmwareEngineNetwork(GetVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
VmwareEngineNetwork

The RPC response.

Overrides

GetVmwareEngineNetworkAsync(GetVmwareEngineNetworkRequest, CallSettings)

public override Task<VmwareEngineNetwork> GetVmwareEngineNetworkAsync(GetVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<VmwareEngineNetwork>

A Task containing the RPC response.

Overrides

ListClusters(ListClustersRequest, CallSettings)

public override PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists Cluster resources in a given private cloud.

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListClustersResponse, Cluster>

A pageable sequence of Cluster resources.

Overrides

ListClustersAsync(ListClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists Cluster resources in a given private cloud.

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListClustersResponse, Cluster>

A pageable asynchronous sequence of Cluster resources.

Overrides

ListHcxActivationKeys(ListHcxActivationKeysRequest, CallSettings)

public override PagedEnumerable<ListHcxActivationKeysResponse, HcxActivationKey> ListHcxActivationKeys(ListHcxActivationKeysRequest request, CallSettings callSettings = null)

Lists HcxActivationKey resources in a given private cloud.

Parameters
NameDescription
requestListHcxActivationKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListHcxActivationKeysResponse, HcxActivationKey>

A pageable sequence of HcxActivationKey resources.

Overrides

ListHcxActivationKeysAsync(ListHcxActivationKeysRequest, CallSettings)

public override PagedAsyncEnumerable<ListHcxActivationKeysResponse, HcxActivationKey> ListHcxActivationKeysAsync(ListHcxActivationKeysRequest request, CallSettings callSettings = null)

Lists HcxActivationKey resources in a given private cloud.

Parameters
NameDescription
requestListHcxActivationKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListHcxActivationKeysResponse, HcxActivationKey>

A pageable asynchronous sequence of HcxActivationKey resources.

Overrides

ListNetworkPolicies(ListNetworkPoliciesRequest, CallSettings)

public override PagedEnumerable<ListNetworkPoliciesResponse, NetworkPolicy> ListNetworkPolicies(ListNetworkPoliciesRequest request, CallSettings callSettings = null)

Lists NetworkPolicy resources in a specified project and location.

Parameters
NameDescription
requestListNetworkPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListNetworkPoliciesResponse, NetworkPolicy>

A pageable sequence of NetworkPolicy resources.

Overrides

ListNetworkPoliciesAsync(ListNetworkPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNetworkPoliciesResponse, NetworkPolicy> ListNetworkPoliciesAsync(ListNetworkPoliciesRequest request, CallSettings callSettings = null)

Lists NetworkPolicy resources in a specified project and location.

Parameters
NameDescription
requestListNetworkPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListNetworkPoliciesResponse, NetworkPolicy>

A pageable asynchronous sequence of NetworkPolicy resources.

Overrides

ListNodeTypes(ListNodeTypesRequest, CallSettings)

public override PagedEnumerable<ListNodeTypesResponse, NodeType> ListNodeTypes(ListNodeTypesRequest request, CallSettings callSettings = null)

Lists node types

Parameters
NameDescription
requestListNodeTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListNodeTypesResponse, NodeType>

A pageable sequence of NodeType resources.

Overrides

ListNodeTypesAsync(ListNodeTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNodeTypesResponse, NodeType> ListNodeTypesAsync(ListNodeTypesRequest request, CallSettings callSettings = null)

Lists node types

Parameters
NameDescription
requestListNodeTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListNodeTypesResponse, NodeType>

A pageable asynchronous sequence of NodeType resources.

Overrides

ListPrivateClouds(ListPrivateCloudsRequest, CallSettings)

public override PagedEnumerable<ListPrivateCloudsResponse, PrivateCloud> ListPrivateClouds(ListPrivateCloudsRequest request, CallSettings callSettings = null)

Lists PrivateCloud resources in a given project and location.

Parameters
NameDescription
requestListPrivateCloudsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPrivateCloudsResponse, PrivateCloud>

A pageable sequence of PrivateCloud resources.

Overrides

ListPrivateCloudsAsync(ListPrivateCloudsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPrivateCloudsResponse, PrivateCloud> ListPrivateCloudsAsync(ListPrivateCloudsRequest request, CallSettings callSettings = null)

Lists PrivateCloud resources in a given project and location.

Parameters
NameDescription
requestListPrivateCloudsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPrivateCloudsResponse, PrivateCloud>

A pageable asynchronous sequence of PrivateCloud resources.

Overrides

ListSubnets(ListSubnetsRequest, CallSettings)

public override PagedEnumerable<ListSubnetsResponse, Subnet> ListSubnets(ListSubnetsRequest request, CallSettings callSettings = null)

Lists subnets in a given private cloud.

Parameters
NameDescription
requestListSubnetsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSubnetsResponse, Subnet>

A pageable sequence of Subnet resources.

Overrides

ListSubnetsAsync(ListSubnetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSubnetsResponse, Subnet> ListSubnetsAsync(ListSubnetsRequest request, CallSettings callSettings = null)

Lists subnets in a given private cloud.

Parameters
NameDescription
requestListSubnetsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSubnetsResponse, Subnet>

A pageable asynchronous sequence of Subnet resources.

Overrides

ListVmwareEngineNetworks(ListVmwareEngineNetworksRequest, CallSettings)

public override PagedEnumerable<ListVmwareEngineNetworksResponse, VmwareEngineNetwork> ListVmwareEngineNetworks(ListVmwareEngineNetworksRequest request, CallSettings callSettings = null)

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
NameDescription
requestListVmwareEngineNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListVmwareEngineNetworksResponse, VmwareEngineNetwork>

A pageable sequence of VmwareEngineNetwork resources.

Overrides

ListVmwareEngineNetworksAsync(ListVmwareEngineNetworksRequest, CallSettings)

public override PagedAsyncEnumerable<ListVmwareEngineNetworksResponse, VmwareEngineNetwork> ListVmwareEngineNetworksAsync(ListVmwareEngineNetworksRequest request, CallSettings callSettings = null)

Lists VmwareEngineNetwork resources in a given project and location.

Parameters
NameDescription
requestListVmwareEngineNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListVmwareEngineNetworksResponse, VmwareEngineNetwork>

A pageable asynchronous sequence of VmwareEngineNetwork resources.

Overrides

ResetNsxCredentials(ResetNsxCredentialsRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> ResetNsxCredentials(ResetNsxCredentialsRequest request, CallSettings callSettings = null)

Resets credentials of the NSX appliance.

Parameters
NameDescription
requestResetNsxCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

ResetNsxCredentialsAsync(ResetNsxCredentialsRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> ResetNsxCredentialsAsync(ResetNsxCredentialsRequest request, CallSettings callSettings = null)

Resets credentials of the NSX appliance.

Parameters
NameDescription
requestResetNsxCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

ResetVcenterCredentials(ResetVcenterCredentialsRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> ResetVcenterCredentials(ResetVcenterCredentialsRequest request, CallSettings callSettings = null)

Resets credentials of the Vcenter appliance.

Parameters
NameDescription
requestResetVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

ResetVcenterCredentialsAsync(ResetVcenterCredentialsRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> ResetVcenterCredentialsAsync(ResetVcenterCredentialsRequest request, CallSettings callSettings = null)

Resets credentials of the Vcenter appliance.

Parameters
NameDescription
requestResetVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

ShowNsxCredentials(ShowNsxCredentialsRequest, CallSettings)

public override Credentials ShowNsxCredentials(ShowNsxCredentialsRequest request, CallSettings callSettings = null)

Gets details of credentials for NSX appliance.

Parameters
NameDescription
requestShowNsxCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Credentials

The RPC response.

Overrides

ShowNsxCredentialsAsync(ShowNsxCredentialsRequest, CallSettings)

public override Task<Credentials> ShowNsxCredentialsAsync(ShowNsxCredentialsRequest request, CallSettings callSettings = null)

Gets details of credentials for NSX appliance.

Parameters
NameDescription
requestShowNsxCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Credentials>

A Task containing the RPC response.

Overrides

ShowVcenterCredentials(ShowVcenterCredentialsRequest, CallSettings)

public override Credentials ShowVcenterCredentials(ShowVcenterCredentialsRequest request, CallSettings callSettings = null)

Gets details of credentials for Vcenter appliance.

Parameters
NameDescription
requestShowVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Credentials

The RPC response.

Overrides

ShowVcenterCredentialsAsync(ShowVcenterCredentialsRequest, CallSettings)

public override Task<Credentials> ShowVcenterCredentialsAsync(ShowVcenterCredentialsRequest request, CallSettings callSettings = null)

Gets details of credentials for Vcenter appliance.

Parameters
NameDescription
requestShowVcenterCredentialsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Credentials>

A Task containing the RPC response.

Overrides

UndeletePrivateCloud(UndeletePrivateCloudRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> UndeletePrivateCloud(UndeletePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

UndeletePrivateCloudAsync(UndeletePrivateCloudRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> UndeletePrivateCloudAsync(UndeletePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateCluster(UpdateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Cluster, OperationMetadata>

The RPC response.

Overrides

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

public override async Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateNetworkPolicy(UpdateNetworkPolicyRequest, CallSettings)

public override Operation<NetworkPolicy, OperationMetadata> UpdateNetworkPolicy(UpdateNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<NetworkPolicy, OperationMetadata>

The RPC response.

Overrides

UpdateNetworkPolicyAsync(UpdateNetworkPolicyRequest, CallSettings)

public override async Task<Operation<NetworkPolicy, OperationMetadata>> UpdateNetworkPolicyAsync(UpdateNetworkPolicyRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpdatePrivateCloud(UpdatePrivateCloudRequest, CallSettings)

public override Operation<PrivateCloud, OperationMetadata> UpdatePrivateCloud(UpdatePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Overrides

UpdatePrivateCloudAsync(UpdatePrivateCloudRequest, CallSettings)

public override async Task<Operation<PrivateCloud, OperationMetadata>> UpdatePrivateCloudAsync(UpdatePrivateCloudRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<PrivateCloud, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest, CallSettings)

public override Operation<VmwareEngineNetwork, OperationMetadata> UpdateVmwareEngineNetwork(UpdateVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<VmwareEngineNetwork, OperationMetadata>

The RPC response.

Overrides

UpdateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest, CallSettings)

public override async Task<Operation<VmwareEngineNetwork, OperationMetadata>> UpdateVmwareEngineNetworkAsync(UpdateVmwareEngineNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateVmwareEngineNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<VmwareEngineNetwork, OperationMetadata>>

A Task containing the RPC response.

Overrides