Class TargetVpnGatewaysClient (2.0.0)

Version 2.0.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 TargetVpnGatewaysClient

TargetVpnGateways client wrapper, for convenient use.

Inheritance

Object > TargetVpnGatewaysClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

TargetVpnGatewaysClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The TargetVpnGateways API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type	Description
IReadOnlyList<String>

Remarks

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

The underlying gRPC TargetVpnGateways client

Property Value
Type	Description
TargetVpnGateways.TargetVpnGatewaysClient

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

Methods

AggregatedList(AggregatedListTargetVpnGatewaysRequest, CallSettings)

public virtual PagedEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> AggregatedList(AggregatedListTargetVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of target VPN gateways.

Parameters
Name	Description
request	AggregatedListTargetVpnGatewaysRequest 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<TargetVpnGatewayAggregatedList, KeyValuePair<String, TargetVpnGatewaysScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
AggregatedListTargetVpnGatewaysRequest request = new AggregatedListTargetVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> response = targetVpnGatewaysClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, TargetVpnGatewaysScopedList> 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 (TargetVpnGatewayAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, TargetVpnGatewaysScopedList> 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, TargetVpnGatewaysScopedList>> 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, TargetVpnGatewaysScopedList> 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<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of target 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	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<TargetVpnGatewayAggregatedList, KeyValuePair<String, TargetVpnGatewaysScopedList>>	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> response = targetVpnGatewaysClient.AggregatedList(project);

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

public virtual PagedAsyncEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> AggregatedListAsync(AggregatedListTargetVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of target VPN gateways.

Parameters
Name	Description
request	AggregatedListTargetVpnGatewaysRequest 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<TargetVpnGatewayAggregatedList, KeyValuePair<String, TargetVpnGatewaysScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
AggregatedListTargetVpnGatewaysRequest request = new AggregatedListTargetVpnGatewaysRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> response = targetVpnGatewaysClient.AggregatedListAsync(request);

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

Retrieves an aggregated list of target 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	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<TargetVpnGatewayAggregatedList, KeyValuePair<String, TargetVpnGatewaysScopedList>>	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<TargetVpnGatewayAggregatedList, KeyValuePair<string, TargetVpnGatewaysScopedList>> response = targetVpnGatewaysClient.AggregatedListAsync(project);

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

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

Returns
Type	Description
TargetVpnGatewaysClient	The created TargetVpnGatewaysClient.

CreateAsync(CancellationToken)

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

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

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

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

Delete(DeleteTargetVpnGatewayRequest, CallSettings)

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

Deletes the specified target VPN gateway.

Parameters
Name	Description
request	DeleteTargetVpnGatewayRequest 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
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
DeleteTargetVpnGatewayRequest request = new DeleteTargetVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    TargetVpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetVpnGatewaysClient.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 = targetVpnGatewaysClient.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 targetVpnGateway, CallSettings callSettings = null)

Deletes the specified target VPN gateway.

Parameters
Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
targetVpnGateway	String Name of the target VPN gateway 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
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetVpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = targetVpnGatewaysClient.Delete(project, region, targetVpnGateway);

// 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 = targetVpnGatewaysClient.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(DeleteTargetVpnGatewayRequest, CallSettings)

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

Deletes the specified target VPN gateway.

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

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

Deletes the specified target VPN gateway.

Parameters
Name	Description
request	DeleteTargetVpnGatewayRequest 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
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteTargetVpnGatewayRequest request = new DeleteTargetVpnGatewayRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    TargetVpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetVpnGatewaysClient.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 targetVpnGatewaysClient.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 targetVpnGateway, CallSettings callSettings = null)

Deletes the specified target VPN gateway.

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

// 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 targetVpnGatewaysClient.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 targetVpnGateway, CancellationToken cancellationToken)

Deletes the specified target VPN gateway.

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

// 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 targetVpnGatewaysClient.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(GetTargetVpnGatewayRequest, CallSettings)

public virtual TargetVpnGateway Get(GetTargetVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
GetTargetVpnGatewayRequest request = new GetTargetVpnGatewayRequest
{
    Region = "",
    Project = "",
    TargetVpnGateway = "",
};
// Make the request
TargetVpnGateway response = targetVpnGatewaysClient.Get(request);

Get(String, String, String, CallSettings)

public virtual TargetVpnGateway Get(string project, string region, string targetVpnGateway, CallSettings callSettings = null)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

Returns
Type	Description
TargetVpnGateway	The RPC response.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string targetVpnGateway = "";
// Make the request
TargetVpnGateway response = targetVpnGatewaysClient.Get(project, region, targetVpnGateway);

GetAsync(GetTargetVpnGatewayRequest, CallSettings)

public virtual Task<TargetVpnGateway> GetAsync(GetTargetVpnGatewayRequest request, CallSettings callSettings = null)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetTargetVpnGatewayRequest request = new GetTargetVpnGatewayRequest
{
    Region = "",
    Project = "",
    TargetVpnGateway = "",
};
// Make the request
TargetVpnGateway response = await targetVpnGatewaysClient.GetAsync(request);

GetAsync(GetTargetVpnGatewayRequest, CancellationToken)

public virtual Task<TargetVpnGateway> GetAsync(GetTargetVpnGatewayRequest request, CancellationToken cancellationToken)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetTargetVpnGatewayRequest request = new GetTargetVpnGatewayRequest
{
    Region = "",
    Project = "",
    TargetVpnGateway = "",
};
// Make the request
TargetVpnGateway response = await targetVpnGatewaysClient.GetAsync(request);

GetAsync(String, String, String, CallSettings)

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

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

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

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetVpnGateway = "";
// Make the request
TargetVpnGateway response = await targetVpnGatewaysClient.GetAsync(project, region, targetVpnGateway);

GetAsync(String, String, String, CancellationToken)

public virtual Task<TargetVpnGateway> GetAsync(string project, string region, string targetVpnGateway, CancellationToken cancellationToken)

Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.

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

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

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string targetVpnGateway = "";
// Make the request
TargetVpnGateway response = await targetVpnGatewaysClient.GetAsync(project, region, targetVpnGateway);

Insert(InsertTargetVpnGatewayRequest, CallSettings)

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

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

Parameters
Name	Description
request	InsertTargetVpnGatewayRequest 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
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
InsertTargetVpnGatewayRequest request = new InsertTargetVpnGatewayRequest
{
    TargetVpnGatewayResource = new TargetVpnGateway(),
    RequestId = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = targetVpnGatewaysClient.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 = targetVpnGatewaysClient.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, TargetVpnGateway, CallSettings)

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

Creates a target 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.
targetVpnGatewayResource	TargetVpnGateway 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
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
TargetVpnGateway targetVpnGatewayResource = new TargetVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = targetVpnGatewaysClient.Insert(project, region, targetVpnGatewayResource);

// 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 = targetVpnGatewaysClient.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(InsertTargetVpnGatewayRequest, CallSettings)

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

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

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

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

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

Parameters
Name	Description
request	InsertTargetVpnGatewayRequest 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
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertTargetVpnGatewayRequest request = new InsertTargetVpnGatewayRequest
{
    TargetVpnGatewayResource = new TargetVpnGateway(),
    RequestId = "",
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await targetVpnGatewaysClient.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 targetVpnGatewaysClient.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, TargetVpnGateway, CallSettings)

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

Creates a target 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.
targetVpnGatewayResource	TargetVpnGateway 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
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetVpnGateway targetVpnGatewayResource = new TargetVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await targetVpnGatewaysClient.InsertAsync(project, region, targetVpnGatewayResource);

// 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 targetVpnGatewaysClient.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, TargetVpnGateway, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, TargetVpnGateway targetVpnGatewayResource, CancellationToken cancellationToken)

Creates a target 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.
targetVpnGatewayResource	TargetVpnGateway 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
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
TargetVpnGateway targetVpnGatewayResource = new TargetVpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await targetVpnGatewaysClient.InsertAsync(project, region, targetVpnGatewayResource);

// 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 targetVpnGatewaysClient.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(ListTargetVpnGatewaysRequest, CallSettings)

public virtual PagedEnumerable<TargetVpnGatewayList, TargetVpnGateway> List(ListTargetVpnGatewaysRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListTargetVpnGatewaysRequest 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<TargetVpnGatewayList, TargetVpnGateway>	A pageable sequence of TargetVpnGateway resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
ListTargetVpnGatewaysRequest request = new ListTargetVpnGatewaysRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<TargetVpnGatewayList, TargetVpnGateway> response = targetVpnGatewaysClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TargetVpnGateway 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 (TargetVpnGatewayList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TargetVpnGateway 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<TargetVpnGateway> 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 (TargetVpnGateway 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<TargetVpnGatewayList, TargetVpnGateway> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of target 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	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<TargetVpnGatewayList, TargetVpnGateway>	A pageable sequence of TargetVpnGateway resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = TargetVpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<TargetVpnGatewayList, TargetVpnGateway> response = targetVpnGatewaysClient.List(project, region);

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

public virtual PagedAsyncEnumerable<TargetVpnGatewayList, TargetVpnGateway> ListAsync(ListTargetVpnGatewaysRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListTargetVpnGatewaysRequest 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<TargetVpnGatewayList, TargetVpnGateway>	A pageable asynchronous sequence of TargetVpnGateway resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
ListTargetVpnGatewaysRequest request = new ListTargetVpnGatewaysRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<TargetVpnGatewayList, TargetVpnGateway> response = targetVpnGatewaysClient.ListAsync(request);

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

Retrieves a list of target 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	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<TargetVpnGatewayList, TargetVpnGateway>	A pageable asynchronous sequence of TargetVpnGateway resources.

Example

// Create client
TargetVpnGatewaysClient targetVpnGatewaysClient = await TargetVpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<TargetVpnGatewayList, TargetVpnGateway> response = targetVpnGatewaysClient.ListAsync(project, region);

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