Compute Engine v1 API - Class ExternalVpnGateways.ExternalVpnGatewaysClient (2.17.0)

Version latest

• 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 ExternalVpnGateways.ExternalVpnGatewaysClient : ClientBase<ExternalVpnGateways.ExternalVpnGatewaysClient>

Reference documentation and code samples for the Compute Engine v1 API class ExternalVpnGateways.ExternalVpnGatewaysClient.

Client for ExternalVpnGateways

Inheritance

object > ClientBase > ClientBaseExternalVpnGatewaysExternalVpnGatewaysClient > ExternalVpnGateways.ExternalVpnGatewaysClient

Inherited Members

ClientBase<ExternalVpnGateways.ExternalVpnGatewaysClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ExternalVpnGatewaysClient()

protected ExternalVpnGatewaysClient()

Protected parameterless constructor to allow creation of test doubles.

ExternalVpnGatewaysClient(CallInvoker)

public ExternalVpnGatewaysClient(CallInvoker callInvoker)

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

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

ExternalVpnGatewaysClient(ChannelBase)

public ExternalVpnGatewaysClient(ChannelBase channel)

Creates a new client for ExternalVpnGateways

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

ExternalVpnGatewaysClient(ClientBaseConfiguration)

protected ExternalVpnGatewaysClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteExternalVpnGatewayRequest, CallOptions)

public virtual Operation Delete(DeleteExternalVpnGatewayRequest request, CallOptions options)

Deletes the specified externalVpnGateway.

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

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

Deletes the specified externalVpnGateway.

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

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

Deletes the specified externalVpnGateway.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified externalVpnGateway.

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

public virtual ExternalVpnGateway Get(GetExternalVpnGatewayRequest request, CallOptions options)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

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

Returns
Type	Description
ExternalVpnGateway	The response received from the server.

Get(GetExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

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

GetAsync(GetExternalVpnGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<ExternalVpnGateway> GetAsync(GetExternalVpnGatewayRequest request, CallOptions options)

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

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

Returns
Type	Description
AsyncUnaryCallExternalVpnGateway	The call object.

GetAsync(GetExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

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

Insert(InsertExternalVpnGatewayRequest, CallOptions)

public virtual Operation Insert(InsertExternalVpnGatewayRequest request, CallOptions options)

Creates a ExternalVpnGateway in the specified project using the data included in the request.

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

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

Creates a ExternalVpnGateway in the specified project using the data included in the request.

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

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

Creates a ExternalVpnGateway in the specified project using the data included in the request.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Creates a ExternalVpnGateway in the specified project using the data included in the request.

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

public virtual ExternalVpnGatewayList List(ListExternalVpnGatewaysRequest request, CallOptions options)

Retrieves the list of ExternalVpnGateway available to the specified project.

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

Returns
Type	Description
ExternalVpnGatewayList	The response received from the server.

List(ListExternalVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of ExternalVpnGateway available to the specified project.

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

ListAsync(ListExternalVpnGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<ExternalVpnGatewayList> ListAsync(ListExternalVpnGatewaysRequest request, CallOptions options)

Retrieves the list of ExternalVpnGateway available to the specified project.

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

Returns
Type	Description
AsyncUnaryCallExternalVpnGatewayList	The call object.

ListAsync(ListExternalVpnGatewaysRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of ExternalVpnGateway available to the specified project.

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

NewInstance(ClientBaseConfiguration)

protected override ExternalVpnGateways.ExternalVpnGatewaysClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ExternalVpnGatewaysExternalVpnGatewaysClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.ExternalVpnGateways.ExternalVpnGatewaysClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetLabels(SetLabelsExternalVpnGatewayRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsExternalVpnGatewayRequest request, CallOptions options)

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

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

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

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

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

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

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

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

TestIamPermissions(TestIamPermissionsExternalVpnGatewayRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsExternalVpnGatewayRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

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

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

Returns permissions that a caller has on the specified resource.

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

TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest, CallOptions)

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

Returns permissions that a caller has on the specified resource.

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

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsExternalVpnGatewayRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

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