Class VpnTunnelsClient (1.4.0)

Version 1.4.0

• 2.17.0 (latest)
• 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 VpnTunnelsClient

VpnTunnels client wrapper, for convenient use.

Inheritance

Object > VpnTunnelsClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

VpnTunnelsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The VpnTunnels API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
IReadOnlyList<String>

Remarks

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

The underlying gRPC VpnTunnels client

Property Value
Type	Description
VpnTunnels.VpnTunnelsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Methods

AggregatedList(AggregatedListVpnTunnelsRequest, CallSettings)

public virtual PagedEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> AggregatedList(AggregatedListVpnTunnelsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN tunnels.

Parameters
Name	Description
request	AggregatedListVpnTunnelsRequest 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
PagedEnumerable<VpnTunnelAggregatedList, KeyValuePair<String, VpnTunnelsScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
AggregatedListVpnTunnelsRequest request = new AggregatedListVpnTunnelsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> response = vpnTunnelsClient.AggregatedList(request);

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

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

Retrieves an aggregated list of VPN tunnels.

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	Nullable<Int32> 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
PagedEnumerable<VpnTunnelAggregatedList, KeyValuePair<String, VpnTunnelsScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> response = vpnTunnelsClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> AggregatedListAsync(AggregatedListVpnTunnelsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN tunnels.

Parameters
Name	Description
request	AggregatedListVpnTunnelsRequest 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
PagedAsyncEnumerable<VpnTunnelAggregatedList, KeyValuePair<String, VpnTunnelsScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
AggregatedListVpnTunnelsRequest request = new AggregatedListVpnTunnelsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> response = vpnTunnelsClient.AggregatedListAsync(request);

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

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

Retrieves an aggregated list of VPN tunnels.

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	Nullable<Int32> 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
PagedAsyncEnumerable<VpnTunnelAggregatedList, KeyValuePair<String, VpnTunnelsScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<VpnTunnelAggregatedList, KeyValuePair<string, VpnTunnelsScopedList>> response = vpnTunnelsClient.AggregatedListAsync(project);

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

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

Returns
Type	Description
VpnTunnelsClient	The created VpnTunnelsClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
Task<VpnTunnelsClient>	The task representing the created VpnTunnelsClient.

Delete(DeleteVpnTunnelRequest, CallSettings)

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

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
request	DeleteVpnTunnelRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
DeleteVpnTunnelRequest request = new DeleteVpnTunnelRequest
{
    RequestId = "",
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnTunnelsClient.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 = vpnTunnelsClient.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 vpnTunnel, CallSettings callSettings = null)

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

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

// 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 = vpnTunnelsClient.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(DeleteVpnTunnelRequest, CallSettings)

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

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
request	DeleteVpnTunnelRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnTunnelRequest request = new DeleteVpnTunnelRequest
{
    RequestId = "",
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.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 vpnTunnelsClient.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(DeleteVpnTunnelRequest, CancellationToken)

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

Deletes the specified VpnTunnel resource.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnTunnelRequest request = new DeleteVpnTunnelRequest
{
    RequestId = "",
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.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 vpnTunnelsClient.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 vpnTunnel, CallSettings callSettings = null)

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

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

// 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 vpnTunnelsClient.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 vpnTunnel, CancellationToken cancellationToken)

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

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

// 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 vpnTunnelsClient.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(GetVpnTunnelRequest, CallSettings)

public virtual VpnTunnel Get(GetVpnTunnelRequest request, CallSettings callSettings = null)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

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

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
GetVpnTunnelRequest request = new GetVpnTunnelRequest
{
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
VpnTunnel response = vpnTunnelsClient.Get(request);

Get(String, String, String, CallSettings)

public virtual VpnTunnel Get(string project, string region, string vpnTunnel, CallSettings callSettings = null)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
VpnTunnel	The RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnTunnel = "";
// Make the request
VpnTunnel response = vpnTunnelsClient.Get(project, region, vpnTunnel);

GetAsync(GetVpnTunnelRequest, CallSettings)

public virtual Task<VpnTunnel> GetAsync(GetVpnTunnelRequest request, CallSettings callSettings = null)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

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

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
GetVpnTunnelRequest request = new GetVpnTunnelRequest
{
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
VpnTunnel response = await vpnTunnelsClient.GetAsync(request);

GetAsync(GetVpnTunnelRequest, CancellationToken)

public virtual Task<VpnTunnel> GetAsync(GetVpnTunnelRequest request, CancellationToken cancellationToken)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

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

Returns
Type	Description
Task<VpnTunnel>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
GetVpnTunnelRequest request = new GetVpnTunnelRequest
{
    Region = "",
    VpnTunnel = "",
    Project = "",
};
// Make the request
VpnTunnel response = await vpnTunnelsClient.GetAsync(request);

GetAsync(String, String, String, CallSettings)

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

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<VpnTunnel>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnTunnel = "";
// Make the request
VpnTunnel response = await vpnTunnelsClient.GetAsync(project, region, vpnTunnel);

GetAsync(String, String, String, CancellationToken)

public virtual Task<VpnTunnel> GetAsync(string project, string region, string vpnTunnel, CancellationToken cancellationToken)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
vpnTunnel	String Name of the VpnTunnel resource to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<VpnTunnel>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnTunnel = "";
// Make the request
VpnTunnel response = await vpnTunnelsClient.GetAsync(project, region, vpnTunnel);

Insert(InsertVpnTunnelRequest, CallSettings)

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

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnTunnelRequest 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
Operation<Operation, Operation>	The RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
InsertVpnTunnelRequest request = new InsertVpnTunnelRequest
{
    RequestId = "",
    VpnTunnelResource = new VpnTunnel(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnTunnelsClient.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 = vpnTunnelsClient.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, VpnTunnel, CallSettings)

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

Creates a VpnTunnel resource 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.
vpnTunnelResource	VpnTunnel The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<Operation, Operation>	The RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
VpnTunnel vpnTunnelResource = new VpnTunnel();
// Make the request
lro::Operation<Operation, Operation> response = vpnTunnelsClient.Insert(project, region, vpnTunnelResource);

// 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 = vpnTunnelsClient.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(InsertVpnTunnelRequest, CallSettings)

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

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnTunnelRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
InsertVpnTunnelRequest request = new InsertVpnTunnelRequest
{
    RequestId = "",
    VpnTunnelResource = new VpnTunnel(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.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 vpnTunnelsClient.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(InsertVpnTunnelRequest, CancellationToken)

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

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

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

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
InsertVpnTunnelRequest request = new InsertVpnTunnelRequest
{
    RequestId = "",
    VpnTunnelResource = new VpnTunnel(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.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 vpnTunnelsClient.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, VpnTunnel, CallSettings)

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

Creates a VpnTunnel resource 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.
vpnTunnelResource	VpnTunnel The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnTunnel vpnTunnelResource = new VpnTunnel();
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.InsertAsync(project, region, vpnTunnelResource);

// 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 vpnTunnelsClient.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, VpnTunnel, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, VpnTunnel vpnTunnelResource, CancellationToken cancellationToken)

Creates a VpnTunnel resource 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.
vpnTunnelResource	VpnTunnel The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnTunnel vpnTunnelResource = new VpnTunnel();
// Make the request
lro::Operation<Operation, Operation> response = await vpnTunnelsClient.InsertAsync(project, region, vpnTunnelResource);

// 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 vpnTunnelsClient.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(ListVpnTunnelsRequest, CallSettings)

public virtual PagedEnumerable<VpnTunnelList, VpnTunnel> List(ListVpnTunnelsRequest request, CallSettings callSettings = null)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Parameters
Name	Description
request	ListVpnTunnelsRequest 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
PagedEnumerable<VpnTunnelList, VpnTunnel>	A pageable sequence of VpnTunnel resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
ListVpnTunnelsRequest request = new ListVpnTunnelsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnTunnelList, VpnTunnel> response = vpnTunnelsClient.List(request);

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

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

Retrieves a list of VpnTunnel resources contained in 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	Nullable<Int32> 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
PagedEnumerable<VpnTunnelList, VpnTunnel>	A pageable sequence of VpnTunnel resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = VpnTunnelsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<VpnTunnelList, VpnTunnel> response = vpnTunnelsClient.List(project, region);

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

public virtual PagedAsyncEnumerable<VpnTunnelList, VpnTunnel> ListAsync(ListVpnTunnelsRequest request, CallSettings callSettings = null)

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Parameters
Name	Description
request	ListVpnTunnelsRequest 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
PagedAsyncEnumerable<VpnTunnelList, VpnTunnel>	A pageable asynchronous sequence of VpnTunnel resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
ListVpnTunnelsRequest request = new ListVpnTunnelsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnTunnelList, VpnTunnel> response = vpnTunnelsClient.ListAsync(request);

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

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

Retrieves a list of VpnTunnel resources contained in 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	Nullable<Int32> 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
PagedAsyncEnumerable<VpnTunnelList, VpnTunnel>	A pageable asynchronous sequence of VpnTunnel resources.

Example

// Create client
VpnTunnelsClient vpnTunnelsClient = await VpnTunnelsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<VpnTunnelList, VpnTunnel> response = vpnTunnelsClient.ListAsync(project, region);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((VpnTunnel 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((VpnTunnelList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (VpnTunnel 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<VpnTunnel> 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 (VpnTunnel 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
Operation<Operation, Operation>	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
Task<Operation<Operation, Operation>>	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
Operation<Operation, Operation>	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
Task<Operation<Operation, Operation>>	A task representing the result of polling the operation.

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.