Compute Engine v1 API - Class VpnTunnelsClientImpl (2.17.0)

public sealed class VpnTunnelsClientImpl : VpnTunnelsClient

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

VpnTunnels client wrapper implementation, for convenient use.

Inheritance

object > VpnTunnelsClient > VpnTunnelsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The VpnTunnels API.

Constructors

VpnTunnelsClientImpl(VpnTunnelsClient, VpnTunnelsSettings, ILogger)

public VpnTunnelsClientImpl(VpnTunnels.VpnTunnelsClient grpcClient, VpnTunnelsSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient VpnTunnelsVpnTunnelsClient

The underlying gRPC client.

settings VpnTunnelsSettings

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

The underlying gRPC VpnTunnels client

Property Value
Type Description
VpnTunnelsVpnTunnelsClient
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(AggregatedListVpnTunnelsRequest, CallSettings)

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

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

Parameters
Name Description
request AggregatedListVpnTunnelsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableVpnTunnelAggregatedListKeyValuePairstringVpnTunnelsScopedList

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

Overrides

AggregatedListAsync(AggregatedListVpnTunnelsRequest, CallSettings)

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

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

Parameters
Name Description
request AggregatedListVpnTunnelsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableVpnTunnelAggregatedListKeyValuePairstringVpnTunnelsScopedList

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

Overrides

Delete(DeleteVpnTunnelRequest, CallSettings)

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

Deletes the specified VpnTunnel resource.

Parameters
Name Description
request DeleteVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

DeleteAsync(DeleteVpnTunnelRequest, CallSettings)

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

Deletes the specified VpnTunnel resource.

Parameters
Name Description
request DeleteVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Get(GetVpnTunnelRequest, CallSettings)

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

Returns the specified VpnTunnel resource.

Parameters
Name Description
request GetVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VpnTunnel

The RPC response.

Overrides

GetAsync(GetVpnTunnelRequest, CallSettings)

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

Returns the specified VpnTunnel resource.

Parameters
Name Description
request GetVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVpnTunnel

A Task containing the RPC response.

Overrides

Insert(InsertVpnTunnelRequest, CallSettings)

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

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

Parameters
Name Description
request InsertVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertVpnTunnelRequest, CallSettings)

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

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

Parameters
Name Description
request InsertVpnTunnelRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListVpnTunnelsRequest, CallSettings)

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

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

Parameters
Name Description
request ListVpnTunnelsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableVpnTunnelListVpnTunnel

A pageable sequence of VpnTunnel resources.

Overrides

ListAsync(ListVpnTunnelsRequest, CallSettings)

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

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

Parameters
Name Description
request ListVpnTunnelsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableVpnTunnelListVpnTunnel

A pageable asynchronous sequence of VpnTunnel resources.

Overrides

SetLabels(SetLabelsVpnTunnelRequest, CallSettings)

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

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

Parameters
Name Description
request SetLabelsVpnTunnelRequest

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(SetLabelsVpnTunnelRequest, CallSettings)

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

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

Parameters
Name Description
request SetLabelsVpnTunnelRequest

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