Compute Engine v1 API - Class VpnGateways.VpnGatewaysClient (2.15.0)

Version 2.15.0

• 2.17.0 (latest)
• 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 VpnGateways.VpnGatewaysClient : ClientBase<VpnGateways.VpnGatewaysClient>

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

Client for VpnGateways

Inheritance

object > ClientBase > ClientBaseVpnGatewaysVpnGatewaysClient > VpnGateways.VpnGatewaysClient

Inherited Members

ClientBase<VpnGateways.VpnGatewaysClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

VpnGatewaysClient()

protected VpnGatewaysClient()

Protected parameterless constructor to allow creation of test doubles.

VpnGatewaysClient(CallInvoker)

public VpnGatewaysClient(CallInvoker callInvoker)

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

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

VpnGatewaysClient(ChannelBase)

public VpnGatewaysClient(ChannelBase channel)

Creates a new client for VpnGateways

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

VpnGatewaysClient(ClientBaseConfiguration)

protected VpnGatewaysClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListVpnGatewaysRequest, CallOptions)

public virtual VpnGatewayAggregatedList AggregatedList(AggregatedListVpnGatewaysRequest request, CallOptions options)

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

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

Returns
Type	Description
VpnGatewayAggregatedList	The response received from the server.

AggregatedList(AggregatedListVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	AggregatedListVpnGatewaysRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
VpnGatewayAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<VpnGatewayAggregatedList> AggregatedListAsync(AggregatedListVpnGatewaysRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallVpnGatewayAggregatedList	The call object.

AggregatedListAsync(AggregatedListVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	AggregatedListVpnGatewaysRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallVpnGatewayAggregatedList	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(DeleteVpnGatewayRequest, CallOptions)

public virtual Operation Delete(DeleteVpnGatewayRequest request, CallOptions options)

Deletes the specified VPN gateway.

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

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

Deletes the specified VPN gateway.

Parameters
Name	Description
request	DeleteVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(DeleteVpnGatewayRequest, CallOptions)

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

Deletes the specified VPN gateway.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified VPN gateway.

Parameters
Name	Description
request	DeleteVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(GetVpnGatewayRequest, CallOptions)

public virtual VpnGateway Get(GetVpnGatewayRequest request, CallOptions options)

Returns the specified VPN gateway.

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

Returns
Type	Description
VpnGateway	The response received from the server.

Get(GetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified VPN gateway.

Parameters
Name	Description
request	GetVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
VpnGateway	The response received from the server.

GetAsync(GetVpnGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<VpnGateway> GetAsync(GetVpnGatewayRequest request, CallOptions options)

Returns the specified VPN gateway.

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

Returns
Type	Description
AsyncUnaryCallVpnGateway	The call object.

GetAsync(GetVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified VPN gateway.

Parameters
Name	Description
request	GetVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallVpnGateway	The call object.

GetStatus(GetStatusVpnGatewayRequest, CallOptions)

public virtual VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallOptions options)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
VpnGatewaysGetStatusResponse	The response received from the server.

GetStatus(GetStatusVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the status for the specified VPN gateway.

Parameters
Name	Description
request	GetStatusVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
VpnGatewaysGetStatusResponse	The response received from the server.

GetStatusAsync(GetStatusVpnGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CallOptions options)

Returns the status for the specified VPN gateway.

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

Returns
Type	Description
AsyncUnaryCallVpnGatewaysGetStatusResponse	The call object.

GetStatusAsync(GetStatusVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the status for the specified VPN gateway.

Parameters
Name	Description
request	GetStatusVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallVpnGatewaysGetStatusResponse	The call object.

Insert(InsertVpnGatewayRequest, CallOptions)

public virtual Operation Insert(InsertVpnGatewayRequest request, CallOptions options)

Creates a VPN gateway in the specified project and region using the data included in the request.

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

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

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(InsertVpnGatewayRequest, CallOptions)

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

Creates a VPN gateway in the specified project and region using the data included in the request.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Creates a VPN gateway in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(ListVpnGatewaysRequest, CallOptions)

public virtual VpnGatewayList List(ListVpnGatewaysRequest request, CallOptions options)

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

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

Returns
Type	Description
VpnGatewayList	The response received from the server.

List(ListVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListVpnGatewaysRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
VpnGatewayList	The response received from the server.

ListAsync(ListVpnGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<VpnGatewayList> ListAsync(ListVpnGatewaysRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallVpnGatewayList	The call object.

ListAsync(ListVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListVpnGatewaysRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallVpnGatewayList	The call object.

NewInstance(ClientBaseConfiguration)

protected override VpnGateways.VpnGatewaysClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
VpnGatewaysVpnGatewaysClient

Overrides

ClientBase<VpnGateways.VpnGatewaysClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SetLabels(SetLabelsVpnGatewayRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsVpnGatewayRequest request, CallOptions options)

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

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

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

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

Parameters
Name	Description
request	SetLabelsVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(SetLabelsVpnGatewayRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
TestPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsVpnGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallTestPermissionsResponse	The call object.