Compute Engine v1 API - Class VpnTunnelsClientImpl (3.1.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

Inherited Members

VpnTunnelsClient.DefaultEndpoint

VpnTunnelsClient.DefaultScopes

VpnTunnelsClient.ServiceMetadata

VpnTunnelsClient.CreateAsync(CancellationToken)

VpnTunnelsClient.Create()

VpnTunnelsClient.ShutdownDefaultChannelsAsync()

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

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

VpnTunnelsClient.DeleteAsync(DeleteVpnTunnelRequest, CancellationToken)

VpnTunnelsClient.PollOnceDelete(string, CallSettings)

VpnTunnelsClient.PollOnceDeleteAsync(string, CallSettings)

VpnTunnelsClient.Delete(string, string, string, CallSettings)

VpnTunnelsClient.DeleteAsync(string, string, string, CallSettings)

VpnTunnelsClient.DeleteAsync(string, string, string, CancellationToken)

VpnTunnelsClient.GetAsync(GetVpnTunnelRequest, CancellationToken)

VpnTunnelsClient.Get(string, string, string, CallSettings)

VpnTunnelsClient.GetAsync(string, string, string, CallSettings)

VpnTunnelsClient.GetAsync(string, string, string, CancellationToken)

VpnTunnelsClient.InsertAsync(InsertVpnTunnelRequest, CancellationToken)

VpnTunnelsClient.PollOnceInsert(string, CallSettings)

VpnTunnelsClient.PollOnceInsertAsync(string, CallSettings)

VpnTunnelsClient.Insert(string, string, VpnTunnel, CallSettings)

VpnTunnelsClient.InsertAsync(string, string, VpnTunnel, CallSettings)

VpnTunnelsClient.InsertAsync(string, string, VpnTunnel, CancellationToken)

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

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

VpnTunnelsClient.SetLabelsAsync(SetLabelsVpnTunnelRequest, CancellationToken)

VpnTunnelsClient.PollOnceSetLabels(string, CallSettings)

VpnTunnelsClient.PollOnceSetLabelsAsync(string, CallSettings)

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

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

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

object.GetHashCode()

object.GetType()

object.ToString()

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

VpnTunnelsClient.DeleteOperationsClient

GrpcClient

public override VpnTunnels.VpnTunnelsClient GrpcClient { get; }

The underlying gRPC VpnTunnels client

Property Value
Type	Description
`VpnTunnelsVpnTunnelsClient`

Overrides

VpnTunnelsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

VpnTunnelsClient.InsertOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

VpnTunnelsClient.SetLabelsOperationsClient

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

VpnTunnelsClient.AggregatedList(AggregatedListVpnTunnelsRequest, CallSettings)

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

VpnTunnelsClient.AggregatedListAsync(AggregatedListVpnTunnelsRequest, CallSettings)

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

VpnTunnelsClient.Delete(DeleteVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.DeleteAsync(DeleteVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.Get(GetVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.GetAsync(GetVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.Insert(InsertVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.InsertAsync(InsertVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.List(ListVpnTunnelsRequest, CallSettings)

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

VpnTunnelsClient.ListAsync(ListVpnTunnelsRequest, CallSettings)

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

VpnTunnelsClient.SetLabels(SetLabelsVpnTunnelRequest, CallSettings)

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

VpnTunnelsClient.SetLabelsAsync(SetLabelsVpnTunnelRequest, CallSettings)