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

Stay organized with collections Save and categorize content based on your preferences.
public abstract class VmwareEngineClient

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

VmwareEngine client wrapper, for convenient use.

Inheritance

Object > VmwareEngineClient

Derived Types

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Remarks

VMwareEngine manages VMware's private clusters in the Cloud.

Properties

CreateClusterOperationsClient

public virtual OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
TypeDescription
OperationsClient

CreateHcxActivationKeyOperationsClient

public virtual OperationsClient CreateHcxActivationKeyOperationsClient { get; }

The long-running operations client for CreateHcxActivationKey.

Property Value
TypeDescription
OperationsClient

CreateNetworkPolicyOperationsClient

public virtual OperationsClient CreateNetworkPolicyOperationsClient { get; }

The long-running operations client for CreateNetworkPolicy.

Property Value
TypeDescription
OperationsClient

CreatePrivateCloudOperationsClient

public virtual OperationsClient CreatePrivateCloudOperationsClient { get; }

The long-running operations client for CreatePrivateCloud.

Property Value
TypeDescription
OperationsClient

CreateVmwareEngineNetworkOperationsClient

public virtual OperationsClient CreateVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for CreateVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the VmwareEngine service, which is a host of "vmwareengine.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default VmwareEngine scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default VmwareEngine scopes are:

DeleteClusterOperationsClient

public virtual OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
TypeDescription
OperationsClient

DeleteNetworkPolicyOperationsClient

public virtual OperationsClient DeleteNetworkPolicyOperationsClient { get; }

The long-running operations client for DeleteNetworkPolicy.

Property Value
TypeDescription
OperationsClient

DeletePrivateCloudOperationsClient

public virtual OperationsClient DeletePrivateCloudOperationsClient { get; }

The long-running operations client for DeletePrivateCloud.

Property Value
TypeDescription
OperationsClient

DeleteVmwareEngineNetworkOperationsClient

public virtual OperationsClient DeleteVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for DeleteVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual VmwareEngine.VmwareEngineClient GrpcClient { get; }

The underlying gRPC VmwareEngine client

Property Value
TypeDescription
VmwareEngine.VmwareEngineClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ResetNsxCredentialsOperationsClient

public virtual OperationsClient ResetNsxCredentialsOperationsClient { get; }

The long-running operations client for ResetNsxCredentials.

Property Value
TypeDescription
OperationsClient

ResetVcenterCredentialsOperationsClient

public virtual OperationsClient ResetVcenterCredentialsOperationsClient { get; }

The long-running operations client for ResetVcenterCredentials.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UndeletePrivateCloudOperationsClient

public virtual OperationsClient UndeletePrivateCloudOperationsClient { get; }

The long-running operations client for UndeletePrivateCloud.

Property Value
TypeDescription
OperationsClient

UpdateClusterOperationsClient

public virtual OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
TypeDescription
OperationsClient

UpdateNetworkPolicyOperationsClient

public virtual OperationsClient UpdateNetworkPolicyOperationsClient { get; }

The long-running operations client for UpdateNetworkPolicy.

Property Value
TypeDescription
OperationsClient

UpdatePrivateCloudOperationsClient

public virtual OperationsClient UpdatePrivateCloudOperationsClient { get; }

The long-running operations client for UpdatePrivateCloud.

Property Value
TypeDescription
OperationsClient

UpdateVmwareEngineNetworkOperationsClient

public virtual OperationsClient UpdateVmwareEngineNetworkOperationsClient { get; }

The long-running operations client for UpdateVmwareEngineNetwork.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static VmwareEngineClient Create()

Synchronously creates a VmwareEngineClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VmwareEngineClientBuilder.

Returns
TypeDescription
VmwareEngineClient

The created VmwareEngineClient.

CreateAsync(CancellationToken)

public static Task<VmwareEngineClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a VmwareEngineClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VmwareEngineClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<VmwareEngineClient>

The task representing the created VmwareEngineClient.

CreateCluster(CreateClusterRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Cluster, OperationMetadata> response = vmwareEngineClient.CreateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(PrivateCloudName, Cluster, String, CallSettings)

public virtual Operation<Cluster, OperationMetadata> CreateCluster(PrivateCloudName parent, Cluster cluster, string clusterId, 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
parentPrivateCloudName

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Cluster, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = vmwareEngineClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(String, Cluster, String, CallSettings)

public virtual Operation<Cluster, OperationMetadata> CreateCluster(string parent, Cluster cluster, string clusterId, 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
parentString

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Cluster, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = vmwareEngineClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(PrivateCloudName, Cluster, String, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(PrivateCloudName parent, Cluster cluster, string clusterId, 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
parentPrivateCloudName

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(PrivateCloudName, Cluster, String, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(PrivateCloudName parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

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
parentPrivateCloudName

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(String, Cluster, String, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, 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
parentString

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(String, Cluster, String, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

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
parentString

Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

clusterCluster

Required. The initial description of the new cluster.

clusterIdString

Required. The user-provided identifier of the new Cluster. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Cluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await vmwareEngineClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKey(CreateHcxActivationKeyRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
CreateHcxActivationKeyRequest request = new CreateHcxActivationKeyRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    HcxActivationKey = new HcxActivationKey(),
    HcxActivationKeyId = "",
    RequestId = "",
};
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = vmwareEngineClient.CreateHcxActivationKey(request);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateHcxActivationKey(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKey(PrivateCloudName, HcxActivationKey, String, CallSettings)

public virtual Operation<HcxActivationKey, OperationMetadata> CreateHcxActivationKey(PrivateCloudName parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CallSettings callSettings = null)

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

Parameters
NameDescription
parentPrivateCloudName

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<HcxActivationKey, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = vmwareEngineClient.CreateHcxActivationKey(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateHcxActivationKey(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKey(String, HcxActivationKey, String, CallSettings)

public virtual Operation<HcxActivationKey, OperationMetadata> CreateHcxActivationKey(string parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<HcxActivationKey, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = vmwareEngineClient.CreateHcxActivationKey(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateHcxActivationKey(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(CreateHcxActivationKeyRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateHcxActivationKeyRequest request = new CreateHcxActivationKeyRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    HcxActivationKey = new HcxActivationKey(),
    HcxActivationKeyId = "",
    RequestId = "",
};
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(request);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(CreateHcxActivationKeyRequest, CancellationToken)

public virtual Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(CreateHcxActivationKeyRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateHcxActivationKeyRequest request = new CreateHcxActivationKeyRequest
{
    ParentAsPrivateCloudName = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]"),
    HcxActivationKey = new HcxActivationKey(),
    HcxActivationKeyId = "",
    RequestId = "",
};
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(request);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(PrivateCloudName, HcxActivationKey, String, CallSettings)

public virtual Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(PrivateCloudName parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CallSettings callSettings = null)

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

Parameters
NameDescription
parentPrivateCloudName

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(PrivateCloudName, HcxActivationKey, String, CancellationToken)

public virtual Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(PrivateCloudName parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentPrivateCloudName

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
PrivateCloudName parent = PrivateCloudName.FromProjectLocationPrivateCloud("[PROJECT]", "[LOCATION]", "[PRIVATE_CLOUD]");
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(String, HcxActivationKey, String, CallSettings)

public virtual Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(string parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateHcxActivationKeyAsync(String, HcxActivationKey, String, CancellationToken)

public virtual Task<Operation<HcxActivationKey, OperationMetadata>> CreateHcxActivationKeyAsync(string parent, HcxActivationKey hcxActivationKey, string hcxActivationKeyId, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentString

Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

hcxActivationKeyHcxActivationKey

Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.

hcxActivationKeyIdString

Required. The user-provided identifier of the HcxActivationKey to be created. This identifier must be unique among HcxActivationKey resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<HcxActivationKey, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/privateClouds/[PRIVATE_CLOUD]";
HcxActivationKey hcxActivationKey = new HcxActivationKey();
string hcxActivationKeyId = "";
// Make the request
Operation<HcxActivationKey, OperationMetadata> response = await vmwareEngineClient.CreateHcxActivationKeyAsync(parent, hcxActivationKey, hcxActivationKeyId);

// Poll until the returned long-running operation is complete
Operation<HcxActivationKey, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
HcxActivationKey result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<HcxActivationKey, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateHcxActivationKeyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    HcxActivationKey retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicy(LocationName, NetworkPolicy, String, CallSettings)

public virtual Operation<NetworkPolicy, OperationMetadata> CreateNetworkPolicy(LocationName parent, NetworkPolicy networkPolicy, string networkPolicyId, 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
parentLocationName

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<NetworkPolicy, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = vmwareEngineClient.CreateNetworkPolicy(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateNetworkPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicy(CreateNetworkPolicyRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
CreateNetworkPolicyRequest request = new CreateNetworkPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    NetworkPolicyId = "",
    NetworkPolicy = new NetworkPolicy(),
    RequestId = "",
};
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = vmwareEngineClient.CreateNetworkPolicy(request);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateNetworkPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicy(String, NetworkPolicy, String, CallSettings)

public virtual Operation<NetworkPolicy, OperationMetadata> CreateNetworkPolicy(string parent, NetworkPolicy networkPolicy, string networkPolicyId, 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
parentString

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<NetworkPolicy, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = vmwareEngineClient.CreateNetworkPolicy(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreateNetworkPolicy(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(LocationName, NetworkPolicy, String, CallSettings)

public virtual Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(LocationName parent, NetworkPolicy networkPolicy, string networkPolicyId, 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
parentLocationName

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(LocationName, NetworkPolicy, String, CancellationToken)

public virtual Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(LocationName parent, NetworkPolicy networkPolicy, string networkPolicyId, CancellationToken cancellationToken)

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
parentLocationName

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(CreateNetworkPolicyRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateNetworkPolicyRequest request = new CreateNetworkPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    NetworkPolicyId = "",
    NetworkPolicy = new NetworkPolicy(),
    RequestId = "",
};
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(CreateNetworkPolicyRequest, CancellationToken)

public virtual Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(CreateNetworkPolicyRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
CreateNetworkPolicyRequest request = new CreateNetworkPolicyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    NetworkPolicyId = "",
    NetworkPolicy = new NetworkPolicy(),
    RequestId = "",
};
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(request);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(String, NetworkPolicy, String, CallSettings)

public virtual Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(string parent, NetworkPolicy networkPolicy, string networkPolicyId, 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
parentString

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreateNetworkPolicyAsync(String, NetworkPolicy, String, CancellationToken)

public virtual Task<Operation<NetworkPolicy, OperationMetadata>> CreateNetworkPolicyAsync(string parent, NetworkPolicy networkPolicy, string networkPolicyId, CancellationToken cancellationToken)

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
parentString

Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1

networkPolicyNetworkPolicy

Required. The network policy configuration to use in the request.

networkPolicyIdString

Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent projects/{my-project}/locations/{us-central1}/networkPolicies and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<NetworkPolicy, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = await VmwareEngineClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
NetworkPolicy networkPolicy = new NetworkPolicy();
string networkPolicyId = "";
// Make the request
Operation<NetworkPolicy, OperationMetadata> response = await vmwareEngineClient.CreateNetworkPolicyAsync(parent, networkPolicy, networkPolicyId);

// Poll until the returned long-running operation is complete
Operation<NetworkPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
NetworkPolicy result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<NetworkPolicy, OperationMetadata> retrievedResponse = await vmwareEngineClient.PollOnceCreateNetworkPolicyAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    NetworkPolicy retrievedResult = retrievedResponse.Result;
}

CreatePrivateCloud(LocationName, PrivateCloud, String, CallSettings)

public virtual Operation<PrivateCloud, OperationMetadata> CreatePrivateCloud(LocationName parent, PrivateCloud privateCloud, string privateCloudId, 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
parentLocationName

Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

privateCloudPrivateCloud

Required. The initial description of the new private cloud.

privateCloudIdString

Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each PrivateCloud within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
PrivateCloud privateCloud = new PrivateCloud();
string privateCloudId = "";
// Make the request
Operation<PrivateCloud, OperationMetadata> response = vmwareEngineClient.CreatePrivateCloud(parent, privateCloud, privateCloudId);

// Poll until the returned long-running operation is complete
Operation<PrivateCloud, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
PrivateCloud result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<PrivateCloud, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreatePrivateCloud(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    PrivateCloud retrievedResult = retrievedResponse.Result;
}

CreatePrivateCloud(CreatePrivateCloudRequest, CallSettings)

public virtual 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.

Example
// Create client
VmwareEngineClient vmwareEngineClient = VmwareEngineClient.Create();
// Initialize request argument(s)
CreatePrivateCloudRequest request = new CreatePrivateCloudRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    PrivateCloudId = "",
    PrivateCloud = new PrivateCloud(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<PrivateCloud, OperationMetadata> response = vmwareEngineClient.CreatePrivateCloud(request);

// Poll until the returned long-running operation is complete
Operation<PrivateCloud, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
PrivateCloud result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<PrivateCloud, OperationMetadata> retrievedResponse = vmwareEngineClient.PollOnceCreatePrivateCloud(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    PrivateCloud retrievedResult = retrievedResponse.Result;
}

CreatePrivateCloud(String, PrivateCloud, String, CallSettings)

public virtual Operation<PrivateCloud, OperationMetadata> CreatePrivateCloud(string parent, PrivateCloud privateCloud, string privateCloudId, 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
parentString

Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a

privateCloudPrivateCloud

Required. The initial description of the new private cloud.

privateCloudIdString

Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each PrivateCloud within the parent and becomes the final token in the name URI. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<PrivateCloud, OperationMetadata>

The RPC response.

Example
// Create client
VmwareEngin