public sealed class VpnGatewaysClientImpl : VpnGatewaysClientReference documentation and code samples for the Compute Engine v1 API class VpnGatewaysClientImpl.
VpnGateways client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The VpnGateways API.
Constructors
VpnGatewaysClientImpl(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 | |
|---|---|
| Name | Description |
grpcClient | VpnGatewaysVpnGatewaysClientThe underlying gRPC client. |
settings | VpnGatewaysSettingsThe base VpnGatewaysSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override VpnGateways.VpnGatewaysClient GrpcClient { get; }The underlying gRPC VpnGateways client
| Property Value | |
|---|---|
| Type | Description |
VpnGatewaysVpnGatewaysClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetLabelsOperationsClient
public override OperationsClient SetLabelsOperationsClient { get; }The long-running operations client for SetLabels.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
AggregatedList(AggregatedListVpnGatewaysRequest, CallSettings)
public override PagedEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedList(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListVpnGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList | A pageable sequence of KeyValuePair<TKey, TValue> resources. |
AggregatedListAsync(AggregatedListVpnGatewaysRequest, CallSettings)
public override PagedAsyncEnumerable<VpnGatewayAggregatedList, KeyValuePair<string, VpnGatewaysScopedList>> AggregatedListAsync(AggregatedListVpnGatewaysRequest request, CallSettings callSettings = null)Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListVpnGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableVpnGatewayAggregatedListKeyValuePairstringVpnGatewaysScopedList | A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
Delete(DeleteVpnGatewayRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteVpnGatewayRequest request, CallSettings callSettings = null)Deletes the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DeleteAsync(DeleteVpnGatewayRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteVpnGatewayRequest request, CallSettings callSettings = null)Deletes the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Get(GetVpnGatewayRequest, CallSettings)
public override VpnGateway Get(GetVpnGatewayRequest request, CallSettings callSettings = null)Returns the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
VpnGateway | The RPC response. |
GetAsync(GetVpnGatewayRequest, CallSettings)
public override Task<VpnGateway> GetAsync(GetVpnGatewayRequest request, CallSettings callSettings = null)Returns the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskVpnGateway | A Task containing the RPC response. |
GetStatus(GetStatusVpnGatewayRequest, CallSettings)
public override VpnGatewaysGetStatusResponse GetStatus(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)Returns the status for the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetStatusVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
VpnGatewaysGetStatusResponse | The RPC response. |
GetStatusAsync(GetStatusVpnGatewayRequest, CallSettings)
public override Task<VpnGatewaysGetStatusResponse> GetStatusAsync(GetStatusVpnGatewayRequest request, CallSettings callSettings = null)Returns the status for the specified VPN gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetStatusVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskVpnGatewaysGetStatusResponse | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | InsertVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
InsertAsync(InsertVpnGatewayRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | InsertVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | ListVpnGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableVpnGatewayListVpnGateway | A pageable sequence of VpnGateway resources. |
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 | |
|---|---|
| Name | Description |
request | ListVpnGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableVpnGatewayListVpnGateway | A pageable asynchronous sequence of VpnGateway resources. |
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 | |
|---|---|
| Name | Description |
request | SetLabelsVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetLabelsAsync(SetLabelsVpnGatewayRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | SetLabelsVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsVpnGatewayRequest, CallSettings)
public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest, CallSettings)
public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsVpnGatewayRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsVpnGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse | A Task containing the RPC response. |