Compute Engine v1 API - Class VpnGatewaysClient (2.9.0)

Version 2.9.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 VpnGatewaysClient

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

VpnGateways client wrapper, for convenient use.

Inheritance

object > VpnGatewaysClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

VpnGatewaysClientImpl

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The VpnGateways API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the VpnGateways 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 VpnGateways scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default VpnGateways 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 VpnGateways.VpnGatewaysClient GrpcClient { get; }

The underlying gRPC VpnGateways client

Property Value
Type	Description
VpnGatewaysVpnGatewaysClient

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

AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)

public virtual PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

Parameters
Name	Description
request	AggregatedListVpnGatewaysRequest 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
PagedEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
AggregatedListVpnGatewaysRequest request = new AggregatedListVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, VpnGatewaysScopedList> 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 (VpnGatewayAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, VpnGatewaysScopedList> 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<KeyValuePair<string, VpnGatewaysScopedList>> 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 (KeyValuePair<string, VpnGatewaysScopedList> 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;

AggregatedList(string, string, int?, CallSettings)

public virtual PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

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
PagedEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedList(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, VpnGatewaysScopedList> 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 (VpnGatewayAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, VpnGatewaysScopedList> 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<KeyValuePair<string, VpnGatewaysScopedList>> 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 (KeyValuePair<string, VpnGatewaysScopedList> 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;

AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)

public virtual PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

Parameters
Name	Description
request	AggregatedListVpnGatewaysRequest 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
PagedAsyncEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
AggregatedListVpnGatewaysRequest request = new AggregatedListVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, VpnGatewaysScopedList> 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((VpnGatewayAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, VpnGatewaysScopedList> 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<KeyValuePair<string, VpnGatewaysScopedList>> 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 (KeyValuePair<string, VpnGatewaysScopedList> 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;

AggregatedListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

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
PagedAsyncEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, VpnGatewaysScopedList> 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((VpnGatewayAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, VpnGatewaysScopedList> 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<KeyValuePair<string, VpnGatewaysScopedList>> 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 (KeyValuePair<string, VpnGatewaysScopedList> 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;

Create()

public static VpnGatewaysClient Create()

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

Returns
Type	Description
VpnGatewaysClient	The created VpnGatewaysClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
TaskVpnGatewaysClient	The task representing the created VpnGatewaysClient.

Delete(DeleteVpnGatewayRequest, CallSettings)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
request	DeleteVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.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 = vpnGatewaysClient.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, string, CallSettings)

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

Deletes the specified VPN gateway.

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

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Delete(project, region, vpnGateway);

// 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 = vpnGatewaysClient.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(DeleteVpnGatewayRequest, CallSettings)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
request	DeleteVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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(DeleteVpnGatewayRequest, CancellationToken)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
request	DeleteVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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, string, CallSettings)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region for this request.
vpnGateway	string Name of the VPN gateway 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(project, region, vpnGateway);

// 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 vpnGatewaysClient.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, string, CancellationToken)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region for this request.
vpnGateway	string Name of the VPN gateway to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(project, region, vpnGateway);

// 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 vpnGatewaysClient.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(GetVpnGatewayRequest, CallSettings)

public virtual VpnGateway Get(GetVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified VPN gateway.

Parameters
Name	Description
request	GetVpnGatewayRequest 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
VpnGateway	The RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGateway response = vpnGatewaysClient.Get(request);

Get(string, string, string, CallSettings)

public virtual VpnGateway Get(string project, string region, string vpnGateway, CallSettings callSettings = null)

Returns the specified VPN gateway.

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

Returns
Type	Description
VpnGateway	The RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = vpnGatewaysClient.Get(project, region, vpnGateway);

GetAsync(GetVpnGatewayRequest, CallSettings)

public virtual Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified VPN gateway.

Parameters
Name	Description
request	GetVpnGatewayRequest 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
TaskVpnGateway	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(request);

GetAsync(GetVpnGatewayRequest, CancellationToken)

public virtual Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CancellationToken cancellationToken)

Returns the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGateway	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<VpnGateway> GetAsync(string project, string region, string vpnGateway, CallSettings callSettings = null)

Returns the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGateway	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(project, region, vpnGateway);

GetAsync(string, string, string, CancellationToken)

public virtual Task<VpnGateway> GetAsync(string project, string region, string vpnGateway, CancellationToken cancellationToken)

Returns the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGateway	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(project, region, vpnGateway);

GetStatus(GetStatusVpnGatewayRequest, CallSettings)

public virtual VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

Parameters
Name	Description
request	GetStatusVpnGatewayRequest 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
VpnGatewaysGetStatusResponse	The RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = vpnGatewaysClient.GetStatus(request);

GetStatus(string, string, string, CallSettings)

public virtual VpnGatewaysGetStatusResponse GetStatus(string project, string region, string vpnGateway, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
VpnGatewaysGetStatusResponse	The RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = vpnGatewaysClient.GetStatus(project, region, vpnGateway);

GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)

public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

Parameters
Name	Description
request	GetStatusVpnGatewayRequest 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
TaskVpnGatewaysGetStatusResponse	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(request);

GetStatusAsync(GetStatusVpnGatewayRequest, CancellationToken)

public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CancellationToken cancellationToken)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGatewaysGetStatusResponse	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
    Region = "",
    Project = "",
    VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(request);

GetStatusAsync(string, string, string, CallSettings)

public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(string project, string region, string vpnGateway, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGatewaysGetStatusResponse	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(project, region, vpnGateway);

GetStatusAsync(string, string, string, CancellationToken)

public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(string project, string region, string vpnGateway, CancellationToken cancellationToken)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
TaskVpnGatewaysGetStatusResponse	A Task containing the RPC response.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(project, region, vpnGateway);

Insert(InsertVpnGatewayRequest, CallSettings)

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

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    VpnGatewayResource = new VpnGateway(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.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 = vpnGatewaysClient.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, string, VpnGateway, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string region, VpnGateway vpnGatewayResource, CallSettings callSettings = null)

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region for this request.
vpnGatewayResource	VpnGateway 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Insert(project, region, vpnGatewayResource);

// 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 = vpnGatewaysClient.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(InsertVpnGatewayRequest, CallSettings)

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

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    VpnGatewayResource = new VpnGateway(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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(InsertVpnGatewayRequest, CancellationToken)

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

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    VpnGatewayResource = new VpnGateway(),
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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, string, VpnGateway, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, VpnGateway vpnGatewayResource, CallSettings callSettings = null)

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region for this request.
vpnGatewayResource	VpnGateway 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(project, region, vpnGatewayResource);

// 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 vpnGatewaysClient.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, string, VpnGateway, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, VpnGateway vpnGatewayResource, CancellationToken cancellationToken)

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region for this request.
vpnGatewayResource	VpnGateway 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(project, region, vpnGatewayResource);

// 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 vpnGatewaysClient.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(ListVpnGatewaysRequest, CallSettings)

public virtual PagedEnumerable<VpnGatewayList, VpnGateway> List(ListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves a list of VPN gateways available to the specified project and region.

Parameters
Name	Description
request	ListVpnGatewaysRequest 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
PagedEnumerableVpnGatewayListVpnGateway	A pageable sequence of VpnGateway resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
ListVpnGatewaysRequest request = new ListVpnGatewaysRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (VpnGateway 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 (VpnGatewayList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (VpnGateway 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<VpnGateway> 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 (VpnGateway 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, string, int?, CallSettings)

public virtual PagedEnumerable<VpnGatewayList, VpnGateway> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of VPN gateways available to the specified project and region.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region 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
PagedEnumerableVpnGatewayListVpnGateway	A pageable sequence of VpnGateway resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.List(project, region);

// Iterate over all response items, lazily performing RPCs as required
foreach (VpnGateway 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 (VpnGatewayList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (VpnGateway 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<VpnGateway> 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 (VpnGateway 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(ListVpnGatewaysRequest, CallSettings)

public virtual PagedAsyncEnumerable<VpnGatewayList, VpnGateway> ListAsync(ListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves a list of VPN gateways available to the specified project and region.

Parameters
Name	Description
request	ListVpnGatewaysRequest 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
PagedAsyncEnumerableVpnGatewayListVpnGateway	A pageable asynchronous sequence of VpnGateway resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
ListVpnGatewaysRequest request = new ListVpnGatewaysRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((VpnGateway 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((VpnGatewayList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (VpnGateway 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<VpnGateway> 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 (VpnGateway 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, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<VpnGatewayList, VpnGateway> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of VPN gateways available to the specified project and region.

Parameters
Name	Description
project	string Project ID for this request.
region	string Name of the region 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
PagedAsyncEnumerableVpnGatewayListVpnGateway	A pageable asynchronous sequence of VpnGateway resources.

Example

// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.ListAsync(project, region);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((VpnGateway 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((VpnGatewayList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (VpnGateway 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<VpnGateway> 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 (VpnGateway 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(SetLabelsVpnGatewayRequest, CallSettings)

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

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Resource = "",
    Project = "",
    RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.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 = vpnGatewaysClient.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, string, RegionSetLabelsRequest, CallSettings)

public virtual Operation<Operation, Operation> SetLabels(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
region	string The region for this request.
resource	string Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.SetLabels(project, region, resource, regionSetLabelsRequestResource);

// 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 = vpnGatewaysClient.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(SetLabelsVpnGatewayRequest, CallSettings)

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

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Resource = "",
    Project = "",
    RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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(SetLabelsVpnGatewayRequest, CancellationToken)

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

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Resource = "",
    Project = "",
    RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.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 vpnGatewaysClient.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, string, RegionSetLabelsRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
region	string The region for this request.
resource	string Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);

// 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 vpnGatewaysClient.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, string, RegionSetLabelsRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CancellationToken cancellationToken)

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
region	string The region for this request.
resource	string Name or id of the resource for this request.
regionSetLabelsRequestResource	RegionSetLabelsRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);

// 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 vpnGatewaysClient.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(TestIamPermissionsVpnGatewayRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = vpnGatewaysClient.TestIamPermissions(request);

TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(string project, string region, 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.
region	string The name of the region 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
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = vpnGatewaysClient.TestIamPermissions(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsVpnGatewayRequest 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, 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.
region	string The name of the region 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, 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.
region	string The name of the region 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
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);