Compute Engine v1 API - Class ForwardingRulesClientImpl (3.1.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

Inherited Members

ForwardingRulesClient.DefaultEndpoint

ForwardingRulesClient.DefaultScopes

ForwardingRulesClient.ServiceMetadata

ForwardingRulesClient.CreateAsync(CancellationToken)

ForwardingRulesClient.Create()

ForwardingRulesClient.ShutdownDefaultChannelsAsync()

ForwardingRulesClient.AggregatedList(string, string, int?, CallSettings)

ForwardingRulesClient.AggregatedListAsync(string, string, int?, CallSettings)

ForwardingRulesClient.DeleteAsync(DeleteForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.PollOnceDelete(string, CallSettings)

ForwardingRulesClient.PollOnceDeleteAsync(string, CallSettings)

ForwardingRulesClient.Delete(string, string, string, CallSettings)

ForwardingRulesClient.DeleteAsync(string, string, string, CallSettings)

ForwardingRulesClient.DeleteAsync(string, string, string, CancellationToken)

ForwardingRulesClient.GetAsync(GetForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.Get(string, string, string, CallSettings)

ForwardingRulesClient.GetAsync(string, string, string, CallSettings)

ForwardingRulesClient.GetAsync(string, string, string, CancellationToken)

ForwardingRulesClient.InsertAsync(InsertForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.PollOnceInsert(string, CallSettings)

ForwardingRulesClient.PollOnceInsertAsync(string, CallSettings)

ForwardingRulesClient.Insert(string, string, ForwardingRule, CallSettings)

ForwardingRulesClient.InsertAsync(string, string, ForwardingRule, CallSettings)

ForwardingRulesClient.InsertAsync(string, string, ForwardingRule, CancellationToken)

ForwardingRulesClient.List(string, string, string, int?, CallSettings)

ForwardingRulesClient.ListAsync(string, string, string, int?, CallSettings)

ForwardingRulesClient.PatchAsync(PatchForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.PollOncePatch(string, CallSettings)

ForwardingRulesClient.PollOncePatchAsync(string, CallSettings)

ForwardingRulesClient.Patch(string, string, string, ForwardingRule, CallSettings)

ForwardingRulesClient.PatchAsync(string, string, string, ForwardingRule, CallSettings)

ForwardingRulesClient.PatchAsync(string, string, string, ForwardingRule, CancellationToken)

ForwardingRulesClient.SetLabelsAsync(SetLabelsForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.PollOnceSetLabels(string, CallSettings)

ForwardingRulesClient.PollOnceSetLabelsAsync(string, CallSettings)

ForwardingRulesClient.SetLabels(string, string, string, RegionSetLabelsRequest, CallSettings)

ForwardingRulesClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CallSettings)

ForwardingRulesClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CancellationToken)

ForwardingRulesClient.SetTargetAsync(SetTargetForwardingRuleRequest, CancellationToken)

ForwardingRulesClient.PollOnceSetTarget(string, CallSettings)

ForwardingRulesClient.PollOnceSetTargetAsync(string, CallSettings)

ForwardingRulesClient.SetTarget(string, string, string, TargetReference, CallSettings)

ForwardingRulesClient.SetTargetAsync(string, string, string, TargetReference, CallSettings)

ForwardingRulesClient.SetTargetAsync(string, string, string, TargetReference, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ForwardingRules API.

Constructors

ForwardingRulesClientImpl(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
Name	Description
`grpcClient`	`ForwardingRulesForwardingRulesClient` The underlying gRPC client.
`settings`	`ForwardingRulesSettings` The base ForwardingRulesSettings used within this client.
`logger`	`ILogger` Optional 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`

Overrides

ForwardingRulesClient.DeleteOperationsClient

GrpcClient

public override ForwardingRules.ForwardingRulesClient GrpcClient { get; }

The underlying gRPC ForwardingRules client

Property Value
Type	Description
`ForwardingRulesForwardingRulesClient`

Overrides

ForwardingRulesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

ForwardingRulesClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
`OperationsClient`

Overrides

ForwardingRulesClient.PatchOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

ForwardingRulesClient.SetLabelsOperationsClient

SetTargetOperationsClient

public override OperationsClient SetTargetOperationsClient { get; }

The long-running operations client for SetTarget.

Property Value
Type	Description
`OperationsClient`

Overrides

ForwardingRulesClient.SetTargetOperationsClient

Methods

AggregatedList(AggregatedListForwardingRulesRequest, CallSettings)

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

Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListForwardingRulesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableForwardingRuleAggregatedListKeyValuePairstringForwardingRulesScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ForwardingRulesClient.AggregatedList(AggregatedListForwardingRulesRequest, CallSettings)

AggregatedListAsync(AggregatedListForwardingRulesRequest, CallSettings)

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

Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
`request`	`AggregatedListForwardingRulesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableForwardingRuleAggregatedListKeyValuePairstringForwardingRulesScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ForwardingRulesClient.AggregatedListAsync(AggregatedListForwardingRulesRequest, CallSettings)

Delete(DeleteForwardingRuleRequest, CallSettings)

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

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
`request`	`DeleteForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ForwardingRulesClient.Delete(DeleteForwardingRuleRequest, CallSettings)

DeleteAsync(DeleteForwardingRuleRequest, CallSettings)

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

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
`request`	`DeleteForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.DeleteAsync(DeleteForwardingRuleRequest, CallSettings)

Get(GetForwardingRuleRequest, CallSettings)

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

Returns the specified ForwardingRule resource.

Parameters
Name	Description
`request`	`GetForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ForwardingRule`	The RPC response.

Overrides

ForwardingRulesClient.Get(GetForwardingRuleRequest, CallSettings)

GetAsync(GetForwardingRuleRequest, CallSettings)

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

Returns the specified ForwardingRule resource.

Parameters
Name	Description
`request`	`GetForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskForwardingRule`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.GetAsync(GetForwardingRuleRequest, CallSettings)

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
Name	Description
`request`	`InsertForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ForwardingRulesClient.Insert(InsertForwardingRuleRequest, CallSettings)

InsertAsync(InsertForwardingRuleRequest, CallSettings)

public override 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
Name	Description
`request`	`InsertForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.InsertAsync(InsertForwardingRuleRequest, CallSettings)

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
Name	Description
`request`	`ListForwardingRulesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableForwardingRuleListForwardingRule`	A pageable sequence of ForwardingRule resources.

Overrides

ForwardingRulesClient.List(ListForwardingRulesRequest, CallSettings)

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
Name	Description
`request`	`ListForwardingRulesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableForwardingRuleListForwardingRule`	A pageable asynchronous sequence of ForwardingRule resources.

Overrides

ForwardingRulesClient.ListAsync(ListForwardingRulesRequest, CallSettings)

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
Name	Description
`request`	`PatchForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ForwardingRulesClient.Patch(PatchForwardingRuleRequest, CallSettings)

PatchAsync(PatchForwardingRuleRequest, CallSettings)

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

Parameters
Name	Description
`request`	`PatchForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.PatchAsync(PatchForwardingRuleRequest, CallSettings)

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
Name	Description
`request`	`SetLabelsForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ForwardingRulesClient.SetLabels(SetLabelsForwardingRuleRequest, CallSettings)

SetLabelsAsync(SetLabelsForwardingRuleRequest, CallSettings)

public override 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
Name	Description
`request`	`SetLabelsForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.SetLabelsAsync(SetLabelsForwardingRuleRequest, CallSettings)

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
Name	Description
`request`	`SetTargetForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

ForwardingRulesClient.SetTarget(SetTargetForwardingRuleRequest, CallSettings)

SetTargetAsync(SetTargetForwardingRuleRequest, CallSettings)

public override 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
Name	Description
`request`	`SetTargetForwardingRuleRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

ForwardingRulesClient.SetTargetAsync(SetTargetForwardingRuleRequest, CallSettings)