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

Version latest

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class VpnTunnels.VpnTunnelsClient : ClientBase<VpnTunnels.VpnTunnelsClient>

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

Client for VpnTunnels

Inheritance

object > ClientBase > ClientBaseVpnTunnelsVpnTunnelsClient > VpnTunnels.VpnTunnelsClient

Inherited Members

ClientBase<VpnTunnels.VpnTunnelsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

VpnTunnelsClient(ChannelBase)

public VpnTunnelsClient(ChannelBase channel)

Creates a new client for VpnTunnels

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

VpnTunnelsClient(ClientBaseConfiguration)

protected VpnTunnelsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListVpnTunnelsRequest, CallOptions)

public virtual VpnTunnelAggregatedList AggregatedList(AggregatedListVpnTunnelsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
VpnTunnelAggregatedList	The response received from the server.

AggregatedList(AggregatedListVpnTunnelsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListVpnTunnelsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnelAggregatedList	The call object.

AggregatedListAsync(AggregatedListVpnTunnelsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnelAggregatedList	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
Type	Description
OperationsOperationsClient	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
Name	Description
request	DeleteVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
request	DeleteVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	DeleteVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified VpnTunnel resource.

Parameters
Name	Description
request	DeleteVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetVpnTunnelRequest, CallOptions)

public virtual VpnTunnel Get(GetVpnTunnelRequest request, CallOptions options)

Returns the specified VpnTunnel resource.

Parameters
Name	Description
request	GetVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
VpnTunnel	The response received from the server.

Get(GetVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified VpnTunnel resource.

Parameters
Name	Description
request	GetVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
VpnTunnel	The response received from the server.

GetAsync(GetVpnTunnelRequest, CallOptions)

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

Returns the specified VpnTunnel resource.

Parameters
Name	Description
request	GetVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnel	The call object.

GetAsync(GetVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified VpnTunnel resource.

Parameters
Name	Description
request	GetVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnel	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
Name	Description
request	InsertVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	InsertVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	InsertVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	InsertVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	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
Name	Description
request	ListVpnTunnelsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
VpnTunnelList	The response received from the server.

List(ListVpnTunnelsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListVpnTunnelsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	ListVpnTunnelsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnelList	The call object.

ListAsync(ListVpnTunnelsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListVpnTunnelsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallVpnTunnelList	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
VpnTunnelsVpnTunnelsClient

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
Name	Description
request	SetLabelsVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabels(SetLabelsVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	SetLabelsVpnTunnelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsVpnTunnelRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsVpnTunnelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.