Compute Engine v1 API - Class VpnTunnels.VpnTunnelsClient (2.6.0)

public class VpnTunnelsClient : ClientBase<VpnTunnels.VpnTunnelsClient>

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

Client for VpnTunnels

Inheritance

Object > ClientBase > ClientBase<VpnTunnels.VpnTunnelsClient> > VpnTunnels.VpnTunnelsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

VpnTunnelsClient()

protected VpnTunnelsClient()

Protected parameterless constructor to allow creation of test doubles.

VpnTunnelsClient(CallInvoker)

public VpnTunnelsClient(CallInvoker callInvoker)

Creates a new client for VpnTunnels that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

VpnTunnelsClient(ChannelBase)

public VpnTunnelsClient(ChannelBase channel)

Creates a new client for VpnTunnels

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

VpnTunnelsClient(ClientBase.ClientBaseConfiguration)

protected VpnTunnelsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListVpnTunnelsRequest, CallOptions)

public virtual VpnTunnelAggregatedList AggregatedList(AggregatedListVpnTunnelsRequest request, CallOptions options)

Retrieves an aggregated list of VPN tunnels.

Parameters
NameDescription
requestAggregatedListVpnTunnelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnTunnelAggregatedList

The response received from the server.

AggregatedList(AggregatedListVpnTunnelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual VpnTunnelAggregatedList AggregatedList(AggregatedListVpnTunnelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of VPN tunnels.

Parameters
NameDescription
requestAggregatedListVpnTunnelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
VpnTunnelAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListVpnTunnelsRequest, CallOptions)

public virtual AsyncUnaryCall<VpnTunnelAggregatedList> AggregatedListAsync(AggregatedListVpnTunnelsRequest request, CallOptions options)

Retrieves an aggregated list of VPN tunnels.

Parameters
NameDescription
requestAggregatedListVpnTunnelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnelAggregatedList>

The call object.

AggregatedListAsync(AggregatedListVpnTunnelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<VpnTunnelAggregatedList> AggregatedListAsync(AggregatedListVpnTunnelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of VPN tunnels.

Parameters
NameDescription
requestAggregatedListVpnTunnelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnelAggregatedList>

The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to RegionOperations.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

Delete(DeleteVpnTunnelRequest, CallOptions)

public virtual Operation Delete(DeleteVpnTunnelRequest request, CallOptions options)

Deletes the specified VpnTunnel resource.

Parameters
NameDescription
requestDeleteVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Delete(DeleteVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified VpnTunnel resource.

Parameters
NameDescription
requestDeleteVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAsync(DeleteVpnTunnelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteVpnTunnelRequest request, CallOptions options)

Deletes the specified VpnTunnel resource.

Parameters
NameDescription
requestDeleteVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified VpnTunnel resource.

Parameters
NameDescription
requestDeleteVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Get(GetVpnTunnelRequest, CallOptions)

public virtual VpnTunnel Get(GetVpnTunnelRequest request, CallOptions options)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
NameDescription
requestGetVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnTunnel

The response received from the server.

Get(GetVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual VpnTunnel Get(GetVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
NameDescription
requestGetVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
VpnTunnel

The response received from the server.

GetAsync(GetVpnTunnelRequest, CallOptions)

public virtual AsyncUnaryCall<VpnTunnel> GetAsync(GetVpnTunnelRequest request, CallOptions options)

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
NameDescription
requestGetVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnel>

The call object.

GetAsync(GetVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<VpnTunnel> GetAsync(GetVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters
NameDescription
requestGetVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnel>

The call object.

Insert(InsertVpnTunnelRequest, CallOptions)

public virtual Operation Insert(InsertVpnTunnelRequest request, CallOptions options)

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

Parameters
NameDescription
requestInsertVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Insert(InsertVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestInsertVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

InsertAsync(InsertVpnTunnelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertVpnTunnelRequest request, CallOptions options)

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

Parameters
NameDescription
requestInsertVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestInsertVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

List(ListVpnTunnelsRequest, CallOptions)

public virtual VpnTunnelList List(ListVpnTunnelsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListVpnTunnelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnTunnelList

The response received from the server.

List(ListVpnTunnelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual VpnTunnelList List(ListVpnTunnelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListVpnTunnelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
VpnTunnelList

The response received from the server.

ListAsync(ListVpnTunnelsRequest, CallOptions)

public virtual AsyncUnaryCall<VpnTunnelList> ListAsync(ListVpnTunnelsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListVpnTunnelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnelList>

The call object.

ListAsync(ListVpnTunnelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<VpnTunnelList> ListAsync(ListVpnTunnelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListVpnTunnelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<VpnTunnelList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override VpnTunnels.VpnTunnelsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
VpnTunnels.VpnTunnelsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.VpnTunnels.VpnTunnelsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetLabels(SetLabelsVpnTunnelRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsVpnTunnelRequest request, CallOptions options)

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

Parameters
NameDescription
requestSetLabelsVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabels(SetLabelsVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SetLabels(SetLabelsVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestSetLabelsVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabelsAsync(SetLabelsVpnTunnelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsVpnTunnelRequest request, CallOptions options)

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

Parameters
NameDescription
requestSetLabelsVpnTunnelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetLabelsAsync(SetLabelsVpnTunnelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsVpnTunnelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestSetLabelsVpnTunnelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.