Compute Engine v1 API - Class ForwardingRulesClientImpl (2.3.0)

public sealed class ForwardingRulesClientImpl : ForwardingRulesClient

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

ForwardingRules client wrapper implementation, for convenient use.

Inheritance

Object > ForwardingRulesClient > ForwardingRulesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ForwardingRules API.

Constructors

ForwardingRulesClientImpl(ForwardingRules.ForwardingRulesClient, ForwardingRulesSettings, ILogger)

public ForwardingRulesClientImpl(ForwardingRules.ForwardingRulesClient grpcClient, ForwardingRulesSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientForwardingRules.ForwardingRulesClient

The underlying gRPC client.

settingsForwardingRulesSettings

The base ForwardingRulesSettings 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 ForwardingRules.ForwardingRulesClient GrpcClient { get; }

The underlying gRPC ForwardingRules client

Property Value
TypeDescription
ForwardingRules.ForwardingRulesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
TypeDescription
OperationsClient
Overrides

SetTargetOperationsClient

public override OperationsClient SetTargetOperationsClient { get; }

The long-running operations client for SetTarget.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListForwardingRulesRequest, CallSettings)

public override PagedEnumerable<ForwardingRuleAggregatedList, KeyValuePair<string, ForwardingRulesScopedList>> AggregatedList(AggregatedListForwardingRulesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of forwarding rules.

Parameters
NameDescription
requestAggregatedListForwardingRulesRequest

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<ForwardingRuleAggregatedList, KeyValuePair<String, ForwardingRulesScopedList>>

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

Overrides

AggregatedListAsync(AggregatedListForwardingRulesRequest, CallSettings)

public override PagedAsyncEnumerable<ForwardingRuleAggregatedList, KeyValuePair<string, ForwardingRulesScopedList>> AggregatedListAsync(AggregatedListForwardingRulesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of forwarding rules.

Parameters
NameDescription
requestAggregatedListForwardingRulesRequest

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<ForwardingRuleAggregatedList, KeyValuePair<String, ForwardingRulesScopedList>>

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

Overrides

Delete(DeleteForwardingRuleRequest, CallSettings)

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

Deletes the specified ForwardingRule resource.

Parameters
NameDescription
requestDeleteForwardingRuleRequest

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(DeleteForwardingRuleRequest, CallSettings)

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

Deletes the specified ForwardingRule resource.

Parameters
NameDescription
requestDeleteForwardingRuleRequest

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(GetForwardingRuleRequest, CallSettings)

public override ForwardingRule Get(GetForwardingRuleRequest request, CallSettings callSettings = null)

Returns the specified ForwardingRule resource.

Parameters
NameDescription
requestGetForwardingRuleRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ForwardingRule

The RPC response.

Overrides

GetAsync(GetForwardingRuleRequest, CallSettings)

public override Task<ForwardingRule> GetAsync(GetForwardingRuleRequest request, CallSettings callSettings = null)

Returns the specified ForwardingRule resource.

Parameters
NameDescription
requestGetForwardingRuleRequest

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

A Task containing the RPC response.

Overrides

Insert(InsertForwardingRuleRequest, CallSettings)

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

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertForwardingRuleRequest

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(InsertForwardingRuleRequest, CallSettings)

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

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Parameters
NameDescription
requestInsertForwardingRuleRequest

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(ListForwardingRulesRequest, CallSettings)

public override PagedEnumerable<ForwardingRuleList, ForwardingRule> List(ListForwardingRulesRequest request, CallSettings callSettings = null)

Retrieves a list of ForwardingRule resources available to the specified project and region.

Parameters
NameDescription
requestListForwardingRulesRequest

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<ForwardingRuleList, ForwardingRule>

A pageable sequence of ForwardingRule resources.

Overrides

ListAsync(ListForwardingRulesRequest, CallSettings)

public override PagedAsyncEnumerable<ForwardingRuleList, ForwardingRule> ListAsync(ListForwardingRulesRequest request, CallSettings callSettings = null)

Retrieves a list of ForwardingRule resources available to the specified project and region.

Parameters
NameDescription
requestListForwardingRulesRequest

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<ForwardingRuleList, ForwardingRule>

A pageable asynchronous sequence of ForwardingRule resources.

Overrides

Patch(PatchForwardingRuleRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchForwardingRuleRequest request, CallSettings callSettings = null)

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

Parameters
NameDescription
requestPatchForwardingRuleRequest

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

PatchAsync(PatchForwardingRuleRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> PatchAsync(PatchForwardingRuleRequest request, CallSettings callSettings = null)

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

Parameters
NameDescription
requestPatchForwardingRuleRequest

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

SetLabels(SetLabelsForwardingRuleRequest, CallSettings)

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

Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsForwardingRuleRequest

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(SetLabelsForwardingRuleRequest, CallSettings)

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

Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsForwardingRuleRequest

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

SetTarget(SetTargetForwardingRuleRequest, CallSettings)

public override Operation<Operation, Operation> SetTarget(SetTargetForwardingRuleRequest request, CallSettings callSettings = null)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Parameters
NameDescription
requestSetTargetForwardingRuleRequest

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

SetTargetAsync(SetTargetForwardingRuleRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SetTargetAsync(SetTargetForwardingRuleRequest request, CallSettings callSettings = null)

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Parameters
NameDescription
requestSetTargetForwardingRuleRequest

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