Compute Engine v1 API - Class TargetVpnGateways.TargetVpnGatewaysClient (3.19.0)

Version latest

• 3.19.0 (latest)
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 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 TargetVpnGateways.TargetVpnGatewaysClient : ClientBase<TargetVpnGateways.TargetVpnGatewaysClient>

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

Client for TargetVpnGateways

Inheritance

object > ClientBase > ClientBaseTargetVpnGatewaysTargetVpnGatewaysClient > TargetVpnGateways.TargetVpnGatewaysClient

Inherited Members

ClientBase<TargetVpnGateways.TargetVpnGatewaysClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

TargetVpnGatewaysClient()

protected TargetVpnGatewaysClient()

Protected parameterless constructor to allow creation of test doubles.

TargetVpnGatewaysClient(CallInvoker)

public TargetVpnGatewaysClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

TargetVpnGatewaysClient(ChannelBase)

public TargetVpnGatewaysClient(ChannelBase channel)

Creates a new client for TargetVpnGateways

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

TargetVpnGatewaysClient(ClientBaseConfiguration)

protected TargetVpnGatewaysClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListTargetVpnGatewaysRequest, CallOptions)

public virtual TargetVpnGatewayAggregatedList AggregatedList(AggregatedListTargetVpnGatewaysRequest request, CallOptions options)

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

Returns
Type	Description
TargetVpnGatewayAggregatedList	The response received from the server.

AggregatedList(AggregatedListTargetVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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 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
TargetVpnGatewayAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListTargetVpnGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<TargetVpnGatewayAggregatedList> AggregatedListAsync(AggregatedListTargetVpnGatewaysRequest request, CallOptions options)

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

Returns
Type	Description
AsyncUnaryCallTargetVpnGatewayAggregatedList	The call object.

AggregatedListAsync(AggregatedListTargetVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallTargetVpnGatewayAggregatedList	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(DeleteTargetVpnGatewayRequest, CallOptions)

public virtual Operation Delete(DeleteTargetVpnGatewayRequest request, CallOptions options)

Deletes the specified target VPN gateway.

Parameters
Name	Description
request	DeleteTargetVpnGatewayRequest 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(DeleteTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified target VPN gateway.

Parameters
Name	Description
request	DeleteTargetVpnGatewayRequest 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(DeleteTargetVpnGatewayRequest, CallOptions)

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

Deletes the specified target VPN gateway.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified target VPN gateway.

Parameters
Name	Description
request	DeleteTargetVpnGatewayRequest 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(GetTargetVpnGatewayRequest, CallOptions)

public virtual TargetVpnGateway Get(GetTargetVpnGatewayRequest request, CallOptions options)

Returns the specified target VPN gateway.

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

Returns
Type	Description
TargetVpnGateway	The response received from the server.

Get(GetTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified target VPN gateway.

Parameters
Name	Description
request	GetTargetVpnGatewayRequest 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
TargetVpnGateway	The response received from the server.

GetAsync(GetTargetVpnGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<TargetVpnGateway> GetAsync(GetTargetVpnGatewayRequest request, CallOptions options)

Returns the specified target VPN gateway.

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

Returns
Type	Description
AsyncUnaryCallTargetVpnGateway	The call object.

GetAsync(GetTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified target VPN gateway.

Parameters
Name	Description
request	GetTargetVpnGatewayRequest 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
AsyncUnaryCallTargetVpnGateway	The call object.

Insert(InsertTargetVpnGatewayRequest, CallOptions)

public virtual Operation Insert(InsertTargetVpnGatewayRequest request, CallOptions options)

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

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

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 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(InsertTargetVpnGatewayRequest, CallOptions)

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

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 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(ListTargetVpnGatewaysRequest, CallOptions)

public virtual TargetVpnGatewayList List(ListTargetVpnGatewaysRequest request, CallOptions options)

Retrieves a list of target VPN gateways available to the specified project and region.

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

Returns
Type	Description
TargetVpnGatewayList	The response received from the server.

List(ListTargetVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of target VPN gateways available to the specified project and region.

Parameters
Name	Description
request	ListTargetVpnGatewaysRequest 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
TargetVpnGatewayList	The response received from the server.

ListAsync(ListTargetVpnGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<TargetVpnGatewayList> ListAsync(ListTargetVpnGatewaysRequest request, CallOptions options)

Retrieves a list of target VPN gateways available to the specified project and region.

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

Returns
Type	Description
AsyncUnaryCallTargetVpnGatewayList	The call object.

ListAsync(ListTargetVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of target VPN gateways available to the specified project and region.

Parameters
Name	Description
request	ListTargetVpnGatewaysRequest 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
AsyncUnaryCallTargetVpnGatewayList	The call object.

NewInstance(ClientBaseConfiguration)

protected override TargetVpnGateways.TargetVpnGatewaysClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
TargetVpnGatewaysTargetVpnGatewaysClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.TargetVpnGateways.TargetVpnGatewaysClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetLabels(SetLabelsTargetVpnGatewayRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsTargetVpnGatewayRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetLabelsTargetVpnGatewayRequest 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(SetLabelsTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsTargetVpnGatewayRequest 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(SetLabelsTargetVpnGatewayRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsTargetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsTargetVpnGatewayRequest 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.