Compute Engine v1 API - Class ExternalVpnGatewaysClient (2.7.0)

Version 2.7.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class ExternalVpnGatewaysClient

Reference documentation and code samples for the Compute Engine v1 API class ExternalVpnGatewaysClient.

ExternalVpnGateways client wrapper, for convenient use.

Inheritance

object > ExternalVpnGatewaysClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ExternalVpnGatewaysClientImpl

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ExternalVpnGateways API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ExternalVpnGateways scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default ExternalVpnGateways scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual ExternalVpnGateways.ExternalVpnGatewaysClient GrpcClient { get; }

The underlying gRPC ExternalVpnGateways client

Property Value
Type	Description
ExternalVpnGatewaysExternalVpnGatewaysClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

SetLabelsOperationsClient

public virtual OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static ExternalVpnGatewaysClient Create()

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

Returns
Type	Description
ExternalVpnGatewaysClient	The created ExternalVpnGatewaysClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskExternalVpnGatewaysClient	The task representing the created ExternalVpnGatewaysClient.

Delete(DeleteExternalVpnGatewayRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteExternalVpnGatewayRequest request, CallSettings callSettings = null)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
request	DeleteExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
DeleteExternalVpnGatewayRequest request = new DeleteExternalVpnGatewayRequest
{
    RequestId = "",
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.Delete(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(string, string, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string externalVpnGateway, CallSettings callSettings = null)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateways to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.Delete(project, externalVpnGateway);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteExternalVpnGatewayRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteExternalVpnGatewayRequest request, CallSettings callSettings = null)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
request	DeleteExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteExternalVpnGatewayRequest request = new DeleteExternalVpnGatewayRequest
{
    RequestId = "",
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteExternalVpnGatewayRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteExternalVpnGatewayRequest request, CancellationToken cancellationToken)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
request	DeleteExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteExternalVpnGatewayRequest request = new DeleteExternalVpnGatewayRequest
{
    RequestId = "",
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string externalVpnGateway, CallSettings callSettings = null)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateways to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.DeleteAsync(project, externalVpnGateway);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string externalVpnGateway, CancellationToken cancellationToken)

Deletes the specified externalVpnGateway.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateways to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.DeleteAsync(project, externalVpnGateway);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetExternalVpnGatewayRequest, CallSettings)

public virtual ExternalVpnGateway Get(GetExternalVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
request	GetExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ExternalVpnGateway	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
GetExternalVpnGatewayRequest request = new GetExternalVpnGatewayRequest
{
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
ExternalVpnGateway response = externalVpnGatewaysClient.Get(request);

Get(string, string, CallSettings)

public virtual ExternalVpnGateway Get(string project, string externalVpnGateway, CallSettings callSettings = null)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateway to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ExternalVpnGateway	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
ExternalVpnGateway response = externalVpnGatewaysClient.Get(project, externalVpnGateway);

GetAsync(GetExternalVpnGatewayRequest, CallSettings)

public virtual Task<ExternalVpnGateway> GetAsync(GetExternalVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
request	GetExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskExternalVpnGateway	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetExternalVpnGatewayRequest request = new GetExternalVpnGatewayRequest
{
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
ExternalVpnGateway response = await externalVpnGatewaysClient.GetAsync(request);

GetAsync(GetExternalVpnGatewayRequest, CancellationToken)

public virtual Task<ExternalVpnGateway> GetAsync(GetExternalVpnGatewayRequest request, CancellationToken cancellationToken)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
request	GetExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskExternalVpnGateway	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetExternalVpnGatewayRequest request = new GetExternalVpnGatewayRequest
{
    ExternalVpnGateway = "",
    Project = "",
};
// Make the request
ExternalVpnGateway response = await externalVpnGatewaysClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<ExternalVpnGateway> GetAsync(string project, string externalVpnGateway, CallSettings callSettings = null)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateway to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskExternalVpnGateway	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
ExternalVpnGateway response = await externalVpnGatewaysClient.GetAsync(project, externalVpnGateway);

GetAsync(string, string, CancellationToken)

public virtual Task<ExternalVpnGateway> GetAsync(string project, string externalVpnGateway, CancellationToken cancellationToken)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGateway	string Name of the externalVpnGateway to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskExternalVpnGateway	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string externalVpnGateway = "";
// Make the request
ExternalVpnGateway response = await externalVpnGatewaysClient.GetAsync(project, externalVpnGateway);

Insert(InsertExternalVpnGatewayRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertExternalVpnGatewayRequest request, CallSettings callSettings = null)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
InsertExternalVpnGatewayRequest request = new InsertExternalVpnGatewayRequest
{
    RequestId = "",
    Project = "",
    ExternalVpnGatewayResource = new ExternalVpnGateway(),
};
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.Insert(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Insert(string, ExternalVpnGateway, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, ExternalVpnGateway externalVpnGatewayResource, CallSettings callSettings = null)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGatewayResource	ExternalVpnGateway The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
ExternalVpnGateway externalVpnGatewayResource = new ExternalVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.Insert(project, externalVpnGatewayResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertExternalVpnGatewayRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertExternalVpnGatewayRequest request, CallSettings callSettings = null)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertExternalVpnGatewayRequest request = new InsertExternalVpnGatewayRequest
{
    RequestId = "",
    Project = "",
    ExternalVpnGatewayResource = new ExternalVpnGateway(),
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertExternalVpnGatewayRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertExternalVpnGatewayRequest request, CancellationToken cancellationToken)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertExternalVpnGatewayRequest request = new InsertExternalVpnGatewayRequest
{
    RequestId = "",
    Project = "",
    ExternalVpnGatewayResource = new ExternalVpnGateway(),
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, ExternalVpnGateway, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, ExternalVpnGateway externalVpnGatewayResource, CallSettings callSettings = null)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGatewayResource	ExternalVpnGateway The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
ExternalVpnGateway externalVpnGatewayResource = new ExternalVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.InsertAsync(project, externalVpnGatewayResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, ExternalVpnGateway, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, ExternalVpnGateway externalVpnGatewayResource, CancellationToken cancellationToken)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
externalVpnGatewayResource	ExternalVpnGateway The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
ExternalVpnGateway externalVpnGatewayResource = new ExternalVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.InsertAsync(project, externalVpnGatewayResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListExternalVpnGatewaysRequest, CallSettings)

public virtual PagedEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> List(ListExternalVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves the list of ExternalVpnGateway available to the specified project.

Parameters
Name	Description
request	ListExternalVpnGatewaysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableExternalVpnGatewayListExternalVpnGateway	A pageable sequence of ExternalVpnGateway resources.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
ListExternalVpnGatewaysRequest request = new ListExternalVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> response = externalVpnGatewaysClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ExternalVpnGateway item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ExternalVpnGatewayList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ExternalVpnGateway item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ExternalVpnGateway> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ExternalVpnGateway item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

List(string, string, int?, CallSettings)

public virtual PagedEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of ExternalVpnGateway available to the specified project.

Parameters
Name	Description
project	string Project ID for this request.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableExternalVpnGatewayListExternalVpnGateway	A pageable sequence of ExternalVpnGateway resources.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> response = externalVpnGatewaysClient.List(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (ExternalVpnGateway item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ExternalVpnGatewayList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ExternalVpnGateway item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ExternalVpnGateway> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ExternalVpnGateway item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(ListExternalVpnGatewaysRequest, CallSettings)

public virtual PagedAsyncEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> ListAsync(ListExternalVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves the list of ExternalVpnGateway available to the specified project.

Parameters
Name	Description
request	ListExternalVpnGatewaysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableExternalVpnGatewayListExternalVpnGateway	A pageable asynchronous sequence of ExternalVpnGateway resources.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
ListExternalVpnGatewaysRequest request = new ListExternalVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> response = externalVpnGatewaysClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ExternalVpnGateway item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ExternalVpnGatewayList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ExternalVpnGateway item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ExternalVpnGateway> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ExternalVpnGateway item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of ExternalVpnGateway available to the specified project.

Parameters
Name	Description
project	string Project ID for this request.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableExternalVpnGatewayListExternalVpnGateway	A pageable asynchronous sequence of ExternalVpnGateway resources.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<ExternalVpnGatewayList, ExternalVpnGateway> response = externalVpnGatewaysClient.ListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ExternalVpnGateway item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ExternalVpnGatewayList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ExternalVpnGateway item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ExternalVpnGateway> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ExternalVpnGateway item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceDelete(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Delete.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Delete .

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of Insert.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of Insert .

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A task representing the result of polling the operation.

PollOnceSetLabels(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceSetLabels(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetLabels.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The result of polling the operation.

PollOnceSetLabelsAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceSetLabelsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetLabels.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A task representing the result of polling the operation.

SetLabels(SetLabelsExternalVpnGatewayRequest, CallSettings)

public virtual Operation<Operation, Operation> SetLabels(SetLabelsExternalVpnGatewayRequest request, CallSettings callSettings = null)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
SetLabelsExternalVpnGatewayRequest request = new SetLabelsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.SetLabels(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabels(string, string, GlobalSetLabelsRequest, CallSettings)

public virtual Operation<Operation, Operation> SetLabels(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = externalVpnGatewaysClient.SetLabels(project, resource, globalSetLabelsRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = externalVpnGatewaysClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(SetLabelsExternalVpnGatewayRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsExternalVpnGatewayRequest request, CallSettings callSettings = null)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsExternalVpnGatewayRequest request = new SetLabelsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.SetLabelsAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(SetLabelsExternalVpnGatewayRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsExternalVpnGatewayRequest request, CancellationToken cancellationToken)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsExternalVpnGatewayRequest request = new SetLabelsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.SetLabelsAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(string, string, GlobalSetLabelsRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.SetLabelsAsync(project, resource, globalSetLabelsRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(string, string, GlobalSetLabelsRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CancellationToken cancellationToken)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await externalVpnGatewaysClient.SetLabelsAsync(project, resource, globalSetLabelsRequestResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await externalVpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

TestIamPermissions(TestIamPermissionsExternalVpnGatewayRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsExternalVpnGatewayRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TestPermissionsResponse	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
TestIamPermissionsExternalVpnGatewayRequest request = new TestIamPermissionsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = externalVpnGatewaysClient.TestIamPermissions(request);

TestIamPermissions(string, string, TestPermissionsRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(string project, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
testPermissionsRequestResource	TestPermissionsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TestPermissionsResponse	The RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = ExternalVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = externalVpnGatewaysClient.TestIamPermissions(project, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTestPermissionsResponse	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsExternalVpnGatewayRequest request = new TestIamPermissionsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await externalVpnGatewaysClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsExternalVpnGatewayRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTestPermissionsResponse	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsExternalVpnGatewayRequest request = new TestIamPermissionsExternalVpnGatewayRequest
{
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await externalVpnGatewaysClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(string, string, TestPermissionsRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
testPermissionsRequestResource	TestPermissionsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTestPermissionsResponse	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await externalVpnGatewaysClient.TestIamPermissionsAsync(project, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(string, string, TestPermissionsRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
testPermissionsRequestResource	TestPermissionsRequest The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTestPermissionsResponse	A Task containing the RPC response.

Example

// Create client
ExternalVpnGatewaysClient externalVpnGatewaysClient = await ExternalVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await externalVpnGatewaysClient.TestIamPermissionsAsync(project, resource, testPermissionsRequestResource);