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

public class VpnGatewaysClient : ClientBase<VpnGateways.VpnGatewaysClient>

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

Client for VpnGateways

Inheritance

Object > ClientBase > ClientBase<VpnGateways.VpnGatewaysClient> > VpnGateways.VpnGatewaysClient

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

VpnGatewaysClient(ChannelBase)

public VpnGatewaysClient(ChannelBase channel)

Creates a new client for VpnGateways

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

VpnGatewaysClient(ClientBase.ClientBaseConfiguration)

protected VpnGatewaysClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListVpnGatewaysRequest, CallOptions)

public virtual VpnGatewayAggregatedList AggregatedList(AggregatedListVpnGatewaysRequest request, CallOptions options)

Retrieves an aggregated list of VPN gateways.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnGatewayAggregatedList

The response received from the server.

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

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

Retrieves an aggregated list of VPN gateways.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

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
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.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnGatewayAggregatedList>

The call object.

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

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

Retrieves an aggregated list of VPN gateways.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

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<VpnGatewayAggregatedList>

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

public virtual Operation Delete(DeleteVpnGatewayRequest request, CallOptions options)

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

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

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

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

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

public virtual VpnGateway Get(GetVpnGatewayRequest request, CallOptions options)

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Parameters
NameDescription
requestGetVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnGateway

The response received from the server.

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

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

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Parameters
NameDescription
requestGetVpnGatewayRequest

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
VpnGateway

The response received from the server.

GetAsync(GetVpnGatewayRequest, CallOptions)

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

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Parameters
NameDescription
requestGetVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnGateway>

The call object.

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

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

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Parameters
NameDescription
requestGetVpnGatewayRequest

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<VpnGateway>

The call object.

GetStatus(GetStatusVpnGatewayRequest, CallOptions)

public virtual VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallOptions options)

Returns the status for the specified VPN gateway.

Parameters
NameDescription
requestGetStatusVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnGatewaysGetStatusResponse

The response received from the server.

GetStatus(GetStatusVpnGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the status for the specified VPN gateway.

Parameters
NameDescription
requestGetStatusVpnGatewayRequest

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
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
NameDescription
requestGetStatusVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnGatewaysGetStatusResponse>

The call object.

GetStatusAsync(GetStatusVpnGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the status for the specified VPN gateway.

Parameters
NameDescription
requestGetStatusVpnGatewayRequest

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<VpnGatewaysGetStatusResponse>

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
NameDescription
requestInsertVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

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

Parameters
NameDescription
requestInsertVpnGatewayRequest

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(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
NameDescription
requestInsertVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

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

Parameters
NameDescription
requestInsertVpnGatewayRequest

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

public virtual VpnGatewayList List(ListVpnGatewaysRequest request, CallOptions options)

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

Parameters
NameDescription
requestListVpnGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
VpnGatewayList

The response received from the server.

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

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

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

Parameters
NameDescription
requestListVpnGatewaysRequest

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
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
NameDescription
requestListVpnGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<VpnGatewayList>

The call object.

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

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

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

Parameters
NameDescription
requestListVpnGatewaysRequest

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<VpnGatewayList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
VpnGateways.VpnGatewaysClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.VpnGateways.VpnGatewaysClient>.NewInstance(Grpc.Core.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
NameDescription
requestSetLabelsVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

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

Parameters
NameDescription
requestSetLabelsVpnGatewayRequest

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(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
NameDescription
requestSetLabelsVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

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

Parameters
NameDescription
requestSetLabelsVpnGatewayRequest

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.

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsVpnGatewayRequest

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
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
NameDescription
requestTestIamPermissionsVpnGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsVpnGatewayRequest

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<TestPermissionsResponse>

The call object.