Compute Engine v1 API - Class VpnGatewaysClientImpl (2.16.0)

public sealed class VpnGatewaysClientImpl : VpnGatewaysClient

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

VpnGateways client wrapper implementation, for convenient use.

Inheritance

object > VpnGatewaysClient > VpnGatewaysClientImpl

Inherited Members

VpnGatewaysClient.DefaultEndpoint

VpnGatewaysClient.DefaultScopes

VpnGatewaysClient.ServiceMetadata

VpnGatewaysClient.CreateAsync(CancellationToken)

VpnGatewaysClient.Create()

VpnGatewaysClient.ShutdownDefaultChannelsAsync()

VpnGatewaysClient.AggregatedList(string, string, int?, CallSettings)

VpnGatewaysClient.AggregatedListAsync(string, string, int?, CallSettings)

VpnGatewaysClient.DeleteAsync(DeleteVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.PollOnceDelete(string, CallSettings)

VpnGatewaysClient.PollOnceDeleteAsync(string, CallSettings)

VpnGatewaysClient.Delete(string, string, string, CallSettings)

VpnGatewaysClient.DeleteAsync(string, string, string, CallSettings)

VpnGatewaysClient.DeleteAsync(string, string, string, CancellationToken)

VpnGatewaysClient.GetAsync(GetVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.Get(string, string, string, CallSettings)

VpnGatewaysClient.GetAsync(string, string, string, CallSettings)

VpnGatewaysClient.GetAsync(string, string, string, CancellationToken)

VpnGatewaysClient.GetStatusAsync(GetStatusVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.GetStatus(string, string, string, CallSettings)

VpnGatewaysClient.GetStatusAsync(string, string, string, CallSettings)

VpnGatewaysClient.GetStatusAsync(string, string, string, CancellationToken)

VpnGatewaysClient.InsertAsync(InsertVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.PollOnceInsert(string, CallSettings)

VpnGatewaysClient.PollOnceInsertAsync(string, CallSettings)

VpnGatewaysClient.Insert(string, string, VpnGateway, CallSettings)

VpnGatewaysClient.InsertAsync(string, string, VpnGateway, CallSettings)

VpnGatewaysClient.InsertAsync(string, string, VpnGateway, CancellationToken)

VpnGatewaysClient.List(string, string, string, int?, CallSettings)

VpnGatewaysClient.ListAsync(string, string, string, int?, CallSettings)

VpnGatewaysClient.SetLabelsAsync(SetLabelsVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.PollOnceSetLabels(string, CallSettings)

VpnGatewaysClient.PollOnceSetLabelsAsync(string, CallSettings)

VpnGatewaysClient.SetLabels(string, string, string, RegionSetLabelsRequest, CallSettings)

VpnGatewaysClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CallSettings)

VpnGatewaysClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CancellationToken)

VpnGatewaysClient.TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CancellationToken)

VpnGatewaysClient.TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

VpnGatewaysClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

VpnGatewaysClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The VpnGateways API.

Constructors

VpnGatewaysClientImpl(VpnGatewaysClient, VpnGatewaysSettings, ILogger)

public VpnGatewaysClientImpl(VpnGateways.VpnGatewaysClient grpcClient, VpnGatewaysSettings settings, ILogger logger)

Constructs a client wrapper for the VpnGateways service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`VpnGatewaysVpnGatewaysClient` The underlying gRPC client.
`settings`	`VpnGatewaysSettings` The base VpnGatewaysSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
`OperationsClient`

Overrides

VpnGatewaysClient.DeleteOperationsClient

GrpcClient

public override VpnGateways.VpnGatewaysClient GrpcClient { get; }

The underlying gRPC VpnGateways client

Property Value
Type	Description
`VpnGatewaysVpnGatewaysClient`

Overrides

VpnGatewaysClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

VpnGatewaysClient.InsertOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

VpnGatewaysClient.SetLabelsOperationsClient

Methods

AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)

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

Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
`PagedEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

VpnGatewaysClient.AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)

AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)

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

Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Returns
Type	Description
`PagedAsyncEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

VpnGatewaysClient.AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)

Delete(DeleteVpnGatewayRequest, CallSettings)

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

Deletes the specified VPN gateway.

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

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

VpnGatewaysClient.Delete(DeleteVpnGatewayRequest, CallSettings)

DeleteAsync(DeleteVpnGatewayRequest, CallSettings)

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

Deletes the specified VPN gateway.

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

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.DeleteAsync(DeleteVpnGatewayRequest, CallSettings)

Get(GetVpnGatewayRequest, CallSettings)

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

Returns the specified VPN gateway.

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

Returns
Type	Description
`VpnGateway`	The RPC response.

Overrides

VpnGatewaysClient.Get(GetVpnGatewayRequest, CallSettings)

GetAsync(GetVpnGatewayRequest, CallSettings)

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

Returns the specified VPN gateway.

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

Returns
Type	Description
`TaskVpnGateway`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.GetAsync(GetVpnGatewayRequest, CallSettings)

GetStatus(GetStatusVpnGatewayRequest, CallSettings)

public override 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.

Overrides

VpnGatewaysClient.GetStatus(GetStatusVpnGatewayRequest, CallSettings)

GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)

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

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
`TaskVpnGatewaysGetStatusResponse`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)

Insert(InsertVpnGatewayRequest, CallSettings)

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

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

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

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

VpnGatewaysClient.Insert(InsertVpnGatewayRequest, CallSettings)

InsertAsync(InsertVpnGatewayRequest, CallSettings)

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

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

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

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.InsertAsync(InsertVpnGatewayRequest, CallSettings)

List(ListVpnGatewaysRequest, CallSettings)

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

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

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

Returns
Type	Description
`PagedEnumerableVpnGatewayListVpnGateway`	A pageable sequence of VpnGateway resources.

Overrides

VpnGatewaysClient.List(ListVpnGatewaysRequest, CallSettings)

ListAsync(ListVpnGatewaysRequest, CallSettings)

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

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

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

Returns
Type	Description
`PagedAsyncEnumerableVpnGatewayListVpnGateway`	A pageable asynchronous sequence of VpnGateway resources.

Overrides

VpnGatewaysClient.ListAsync(ListVpnGatewaysRequest, CallSettings)

SetLabels(SetLabelsVpnGatewayRequest, CallSettings)

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

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

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

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

VpnGatewaysClient.SetLabels(SetLabelsVpnGatewayRequest, CallSettings)

SetLabelsAsync(SetLabelsVpnGatewayRequest, CallSettings)

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

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

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

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.SetLabelsAsync(SetLabelsVpnGatewayRequest, CallSettings)

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallSettings)

public override 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.

Overrides

VpnGatewaysClient.TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
`TaskTestPermissionsResponse`	A Task containing the RPC response.

Overrides

VpnGatewaysClient.TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)