public abstract class VpnGatewaysClient
VpnGateways client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The VpnGateways API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the VpnGateways service, which is a host of "compute.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default VpnGateways scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default VpnGateways scopes are:
DeleteOperationsClient
public virtual OperationsClient DeleteOperationsClient { get; }
The long-running operations client for Delete
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual VpnGateways.VpnGatewaysClient GrpcClient { get; }
The underlying gRPC VpnGateways client
Property Value | |
---|---|
Type | Description |
VpnGateways.VpnGatewaysClient |
InsertOperationsClient
public virtual OperationsClient InsertOperationsClient { get; }
The long-running operations client for Insert
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
SetLabelsOperationsClient
public virtual OperationsClient SetLabelsOperationsClient { get; }
The long-running operations client for SetLabels
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)
public virtual PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of VPN gateways.
Parameters | |
---|---|
Name | Description |
request | AggregatedListVpnGatewaysRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
AggregatedListVpnGatewaysRequest request = new AggregatedListVpnGatewaysRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (VpnGatewayAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, VpnGatewaysScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedList(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of VPN gateways.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (VpnGatewayAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, VpnGatewaysScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)
public virtual PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)
Retrieves an aggregated list of VPN gateways.
Parameters | |
---|---|
Name | Description |
request | AggregatedListVpnGatewaysRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
AggregatedListVpnGatewaysRequest request = new AggregatedListVpnGatewaysRequest
{
OrderBy = "",
Project = "",
Filter = "",
IncludeAllScopes = false,
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, VpnGatewaysScopedList> item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((VpnGatewayAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, VpnGatewaysScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedListAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves an aggregated list of VPN gateways.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> response = vpnGatewaysClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, VpnGatewaysScopedList> item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((VpnGatewayAggregatedList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, VpnGatewaysScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, VpnGatewaysScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
Create()
public static VpnGatewaysClient Create()
Synchronously creates a VpnGatewaysClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VpnGatewaysClientBuilder.
Returns | |
---|---|
Type | Description |
VpnGatewaysClient | The created VpnGatewaysClient. |
CreateAsync(CancellationToken)
public static Task<VpnGatewaysClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a VpnGatewaysClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VpnGatewaysClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<VpnGatewaysClient> | The task representing the created VpnGatewaysClient. |
Delete(DeleteVpnGatewayRequest, CallSettings)
public virtual Operation<Operation, Operation> Delete(DeleteVpnGatewayRequest request, CallSettings callSettings = null)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
RequestId = "",
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Delete(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Delete(String, String, String, CallSettings)
public virtual Operation<Operation, Operation> Delete(string project, string region, string vpnGateway, CallSettings callSettings = null)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Delete(project, region, vpnGateway);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(DeleteVpnGatewayRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteVpnGatewayRequest request, CallSettings callSettings = null)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
RequestId = "",
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(DeleteVpnGatewayRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteVpnGatewayRequest request, CancellationToken cancellationToken)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | DeleteVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
DeleteVpnGatewayRequest request = new DeleteVpnGatewayRequest
{
RequestId = "",
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(String, String, String, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string vpnGateway, CallSettings callSettings = null)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(project, region, vpnGateway);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(String, String, String, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string vpnGateway, CancellationToken cancellationToken)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.DeleteAsync(project, region, vpnGateway);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Get(GetVpnGatewayRequest, CallSettings)
public virtual VpnGateway Get(GetVpnGatewayRequest request, CallSettings callSettings = null)
Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
VpnGateway | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGateway response = vpnGatewaysClient.Get(request);
Get(String, String, String, CallSettings)
public virtual VpnGateway Get(string project, string region, string vpnGateway, CallSettings callSettings = null)
Returns the specified VPN gateway. Gets a list of available 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. |
vpnGateway | String Name of the VPN gateway to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
VpnGateway | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = vpnGatewaysClient.Get(project, region, vpnGateway);
GetAsync(GetVpnGatewayRequest, CallSettings)
public virtual Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CallSettings callSettings = null)
Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<VpnGateway> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(request);
GetAsync(GetVpnGatewayRequest, CancellationToken)
public virtual Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CancellationToken cancellationToken)
Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
Parameters | |
---|---|
Name | Description |
request | GetVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<VpnGateway> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetVpnGatewayRequest request = new GetVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(request);
GetAsync(String, String, String, CallSettings)
public virtual Task<VpnGateway> GetAsync(string project, string region, string vpnGateway, CallSettings callSettings = null)
Returns the specified VPN gateway. Gets a list of available 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. |
vpnGateway | String Name of the VPN gateway to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<VpnGateway> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(project, region, vpnGateway);
GetAsync(String, String, String, CancellationToken)
public virtual Task<VpnGateway> GetAsync(string project, string region, string vpnGateway, CancellationToken cancellationToken)
Returns the specified VPN gateway. Gets a list of available 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. |
vpnGateway | String Name of the VPN gateway to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<VpnGateway> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGateway response = await vpnGatewaysClient.GetAsync(project, region, vpnGateway);
GetStatus(GetStatusVpnGatewayRequest, CallSettings)
public virtual VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | GetStatusVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
VpnGatewaysGetStatusResponse | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = vpnGatewaysClient.GetStatus(request);
GetStatus(String, String, String, CallSettings)
public virtual VpnGatewaysGetStatusResponse GetStatus(string project, string region, string vpnGateway, CallSettings callSettings = null)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
VpnGatewaysGetStatusResponse | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = vpnGatewaysClient.GetStatus(project, region, vpnGateway);
GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)
public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | GetStatusVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<VpnGatewaysGetStatusResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(request);
GetStatusAsync(GetStatusVpnGatewayRequest, CancellationToken)
public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CancellationToken cancellationToken)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request | GetStatusVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<VpnGatewaysGetStatusResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
GetStatusVpnGatewayRequest request = new GetStatusVpnGatewayRequest
{
Region = "",
Project = "",
VpnGateway = "",
};
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(request);
GetStatusAsync(String, String, String, CallSettings)
public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(string project, string region, string vpnGateway, CallSettings callSettings = null)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to return. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<VpnGatewaysGetStatusResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(project, region, vpnGateway);
GetStatusAsync(String, String, String, CancellationToken)
public virtual Task<VpnGatewaysGetStatusResponse> GetStatusAsync(string project, string region, string vpnGateway, CancellationToken cancellationToken)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGateway | String Name of the VPN gateway to return. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<VpnGatewaysGetStatusResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string vpnGateway = "";
// Make the request
VpnGatewaysGetStatusResponse response = await vpnGatewaysClient.GetStatusAsync(project, region, vpnGateway);
Insert(InsertVpnGatewayRequest, CallSettings)
public virtual Operation<Operation, Operation> Insert(InsertVpnGatewayRequest request, CallSettings callSettings = null)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
RequestId = "",
Region = "",
VpnGatewayResource = new VpnGateway(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Insert(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Insert(String, String, VpnGateway, CallSettings)
public virtual Operation<Operation, Operation> Insert(string project, string region, VpnGateway vpnGatewayResource, CallSettings callSettings = null)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGatewayResource | VpnGateway The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.Insert(project, region, vpnGatewayResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(InsertVpnGatewayRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertVpnGatewayRequest request, CallSettings callSettings = null)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
RequestId = "",
Region = "",
VpnGatewayResource = new VpnGateway(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(InsertVpnGatewayRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertVpnGatewayRequest request, CancellationToken cancellationToken)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request | InsertVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
InsertVpnGatewayRequest request = new InsertVpnGatewayRequest
{
RequestId = "",
Region = "",
VpnGatewayResource = new VpnGateway(),
Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(String, String, VpnGateway, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, VpnGateway vpnGatewayResource, CallSettings callSettings = null)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGatewayResource | VpnGateway The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(project, region, vpnGatewayResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(String, String, VpnGateway, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, VpnGateway vpnGatewayResource, CancellationToken cancellationToken)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
vpnGatewayResource | VpnGateway The body resource for this request |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
VpnGateway vpnGatewayResource = new VpnGateway();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.InsertAsync(project, region, vpnGatewayResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
List(ListVpnGatewaysRequest, CallSettings)
public virtual PagedEnumerable<VpnGatewayList, VpnGateway> List(ListVpnGatewaysRequest request, CallSettings callSettings = null)
Retrieves a list of VPN gateways available to the specified project and region.
Parameters | |
---|---|
Name | Description |
request | ListVpnGatewaysRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<VpnGatewayList, VpnGateway> | A pageable sequence of VpnGateway resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
ListVpnGatewaysRequest request = new ListVpnGatewaysRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (VpnGateway item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (VpnGatewayList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (VpnGateway item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<VpnGateway> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (VpnGateway item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
List(String, String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<VpnGatewayList, VpnGateway> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of VPN gateways available to the specified project and region.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<VpnGatewayList, VpnGateway> | A pageable sequence of VpnGateway resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.List(project, region);
// Iterate over all response items, lazily performing RPCs as required
foreach (VpnGateway item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (VpnGatewayList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (VpnGateway item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<VpnGateway> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (VpnGateway item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(ListVpnGatewaysRequest, CallSettings)
public virtual PagedAsyncEnumerable<VpnGatewayList, VpnGateway> ListAsync(ListVpnGatewaysRequest request, CallSettings callSettings = null)
Retrieves a list of VPN gateways available to the specified project and region.
Parameters | |
---|---|
Name | Description |
request | ListVpnGatewaysRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> | A pageable asynchronous sequence of VpnGateway resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
ListVpnGatewaysRequest request = new ListVpnGatewaysRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((VpnGateway item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((VpnGatewayList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (VpnGateway item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<VpnGateway> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (VpnGateway item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(String, String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<VpnGatewayList, VpnGateway> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Retrieves a list of VPN gateways available to the specified project and region.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> | A pageable asynchronous sequence of VpnGateway resources. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<VpnGatewayList, VpnGateway> response = vpnGatewaysClient.ListAsync(project, region);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((VpnGateway item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((VpnGatewayList page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (VpnGateway item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<VpnGateway> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (VpnGateway item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
PollOnceDelete(String, CallSettings)
public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of Delete
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
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 |
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 |
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 |
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. |
PollOnceSetLabels(String, CallSettings)
public virtual Operation<Operation, Operation> PollOnceSetLabels(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of SetLabels
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The result of polling the operation. |
PollOnceSetLabelsAsync(String, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceSetLabelsAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
SetLabels
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
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. |
SetLabels(SetLabelsVpnGatewayRequest, CallSettings)
public virtual Operation<Operation, Operation> SetLabels(SetLabelsVpnGatewayRequest request, CallSettings callSettings = null)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request | SetLabelsVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.SetLabels(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabels(String, String, String, RegionSetLabelsRequest, CallSettings)
public virtual Operation<Operation, Operation> SetLabels(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The region for this request. |
resource | String Name or id of the resource for this request. |
regionSetLabelsRequestResource | RegionSetLabelsRequest The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Operation, Operation> | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = vpnGatewaysClient.SetLabels(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = vpnGatewaysClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(SetLabelsVpnGatewayRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsVpnGatewayRequest request, CallSettings callSettings = null)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request | SetLabelsVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(SetLabelsVpnGatewayRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsVpnGatewayRequest request, CancellationToken cancellationToken)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
request | SetLabelsVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
SetLabelsVpnGatewayRequest request = new SetLabelsVpnGatewayRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(String, String, String, RegionSetLabelsRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The region for this request. |
resource | String Name or id of the resource for this request. |
regionSetLabelsRequestResource | RegionSetLabelsRequest The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(String, String, String, RegionSetLabelsRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CancellationToken cancellationToken)
Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The region for this request. |
resource | String Name or id of the resource for this request. |
regionSetLabelsRequestResource | RegionSetLabelsRequest The body resource for this request |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await vpnGatewaysClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await vpnGatewaysClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallSettings)
public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = vpnGatewaysClient.TestIamPermissions(request);
TestIamPermissions(String, String, String, TestPermissionsRequest, CallSettings)
public virtual TestPermissionsResponse TestIamPermissions(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
testPermissionsRequestResource | TestPermissionsRequest The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse | The RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = VpnGatewaysClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = vpnGatewaysClient.TestIamPermissions(project, region, resource, testPermissionsRequestResource);
TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsVpnGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<TestPermissionsResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CancellationToken)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, CancellationToken cancellationToken)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsVpnGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<TestPermissionsResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsVpnGatewayRequest request = new TestIamPermissionsVpnGatewayRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(String, String, String, TestPermissionsRequest, CallSettings)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
testPermissionsRequestResource | TestPermissionsRequest The body resource for this request |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<TestPermissionsResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);
TestIamPermissionsAsync(String, String, String, TestPermissionsRequest, CancellationToken)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
testPermissionsRequestResource | TestPermissionsRequest The body resource for this request |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<TestPermissionsResponse> | A Task containing the RPC response. |
// Create client
VpnGatewaysClient vpnGatewaysClient = await VpnGatewaysClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await vpnGatewaysClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);