Compute Engine v1 API - Class TargetVpnGatewaysClientImpl (2.17.0)

public sealed class TargetVpnGatewaysClientImpl : TargetVpnGatewaysClient

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

TargetVpnGateways client wrapper implementation, for convenient use.

Inheritance

object > TargetVpnGatewaysClient > TargetVpnGatewaysClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The TargetVpnGateways API.

Constructors

TargetVpnGatewaysClientImpl(TargetVpnGatewaysClient, TargetVpnGatewaysSettings, ILogger)

public TargetVpnGatewaysClientImpl(TargetVpnGateways.TargetVpnGatewaysClient grpcClient, TargetVpnGatewaysSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient TargetVpnGatewaysTargetVpnGatewaysClient

The underlying gRPC client.

settings TargetVpnGatewaysSettings

The base TargetVpnGatewaysSettings 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

GrpcClient

public override TargetVpnGateways.TargetVpnGatewaysClient GrpcClient { get; }

The underlying gRPC TargetVpnGateways client

Property Value
Type Description
TargetVpnGatewaysTargetVpnGatewaysClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListTargetVpnGatewaysRequest, CallSettings)

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

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

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
PagedEnumerableTargetVpnGatewayAggregatedListKeyValuePairstringTargetVpnGatewaysScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

AggregatedListAsync(AggregatedListTargetVpnGatewaysRequest, CallSettings)

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

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

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
PagedAsyncEnumerableTargetVpnGatewayAggregatedListKeyValuePairstringTargetVpnGatewaysScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

Delete(DeleteTargetVpnGatewayRequest, CallSettings)

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

The RPC response.

Overrides

DeleteAsync(DeleteTargetVpnGatewayRequest, CallSettings)

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

A Task containing the RPC response.

Overrides

Get(GetTargetVpnGatewayRequest, CallSettings)

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

Returns the specified target VPN gateway.

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.

Overrides

GetAsync(GetTargetVpnGatewayRequest, CallSettings)

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

Returns the specified target VPN gateway.

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
TaskTargetVpnGateway

A Task containing the RPC response.

Overrides

Insert(InsertTargetVpnGatewayRequest, CallSettings)

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

The RPC response.

Overrides

InsertAsync(InsertTargetVpnGatewayRequest, CallSettings)

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

A Task containing the RPC response.

Overrides

List(ListTargetVpnGatewaysRequest, CallSettings)

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

A pageable sequence of TargetVpnGateway resources.

Overrides

ListAsync(ListTargetVpnGatewaysRequest, CallSettings)

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

A pageable asynchronous sequence of TargetVpnGateway resources.

Overrides

SetLabels(SetLabelsTargetVpnGatewayRequest, CallSettings)

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

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

Parameters
Name Description
request SetLabelsTargetVpnGatewayRequest

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

SetLabelsAsync(SetLabelsTargetVpnGatewayRequest, CallSettings)

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

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

Parameters
Name Description
request SetLabelsTargetVpnGatewayRequest

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