Compute Engine v1 API - Class VpnGatewaysClientImpl (2.3.0)

public sealed class VpnGatewaysClientImpl : VpnGatewaysClient

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

VpnGateways client wrapper implementation, for convenient use.

Inheritance

Object > VpnGatewaysClient > VpnGatewaysClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The VpnGateways API.

Constructors

VpnGatewaysClientImpl(VpnGateways.VpnGatewaysClient, VpnGatewaysSettings, ILogger)

public VpnGatewaysClientImpl(VpnGateways.VpnGatewaysClient grpcClient, VpnGatewaysSettings settings, ILogger logger)

Constructs a client wrapper for the VpnGateways service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientVpnGateways.VpnGatewaysClient

The underlying gRPC client.

settingsVpnGatewaysSettings

The base VpnGatewaysSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override VpnGateways.VpnGatewaysClient GrpcClient { get; }

The underlying gRPC VpnGateways client

Property Value
TypeDescription
VpnGateways.VpnGatewaysClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)

public override PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>>

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)

public override PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of VPN gateways.

Parameters
NameDescription
requestAggregatedListVpnGatewaysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<String, VpnGatewaysScopedList>>

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

Delete(DeleteVpnGatewayRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteVpnGatewayRequest request, CallSettings callSettings = null)

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteAsync(DeleteVpnGatewayRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> DeleteAsync(DeleteVpnGatewayRequest request, CallSettings callSettings = null)

Deletes the specified VPN gateway.

Parameters
NameDescription
requestDeleteVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Get(GetVpnGatewayRequest, CallSettings)

public override VpnGateway Get(GetVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
VpnGateway

The RPC response.

Overrides

GetAsync(GetVpnGatewayRequest, CallSettings)

public override Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<VpnGateway>

A Task containing the RPC response.

Overrides

GetStatus(GetStatusVpnGatewayRequest, CallSettings)

public override VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

Parameters
NameDescription
requestGetStatusVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
VpnGatewaysGetStatusResponse

The RPC response.

Overrides

GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)

public override Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)

Returns the status for the specified VPN gateway.

Parameters
NameDescription
requestGetStatusVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<VpnGatewaysGetStatusResponse>

A Task containing the RPC response.

Overrides

Insert(InsertVpnGatewayRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InsertAsync(InsertVpnGatewayRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> InsertAsync(InsertVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

List(ListVpnGatewaysRequest, CallSettings)

public override PagedEnumerable<VpnGatewayList, VpnGateway> List(ListVpnGatewaysRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListVpnGatewaysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<VpnGatewayList, VpnGateway>

A pageable sequence of VpnGateway resources.

Overrides

ListAsync(ListVpnGatewaysRequest, CallSettings)

public override PagedAsyncEnumerable<VpnGatewayList, VpnGateway> ListAsync(ListVpnGatewaysRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListVpnGatewaysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<VpnGatewayList, VpnGateway>

A pageable asynchronous sequence of VpnGateway resources.

Overrides

SetLabels(SetLabelsVpnGatewayRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetLabelsVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

SetLabelsAsync(SetLabelsVpnGatewayRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsVpnGatewayRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetLabelsVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsVpnGatewayRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Overrides