Compute Engine v1 API - Class GlobalForwardingRulesClientImpl (2.5.0)

Version 2.5.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class GlobalForwardingRulesClientImpl : GlobalForwardingRulesClient

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

GlobalForwardingRules client wrapper implementation, for convenient use.

Inheritance

Object > GlobalForwardingRulesClient > GlobalForwardingRulesClientImpl

Inherited Members

GlobalForwardingRulesClient.DefaultEndpoint

GlobalForwardingRulesClient.DefaultScopes

GlobalForwardingRulesClient.ServiceMetadata

GlobalForwardingRulesClient.CreateAsync(CancellationToken)

GlobalForwardingRulesClient.Create()

GlobalForwardingRulesClient.ShutdownDefaultChannelsAsync()

GlobalForwardingRulesClient.DeleteAsync(DeleteGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.PollOnceDelete(String, CallSettings)

GlobalForwardingRulesClient.PollOnceDeleteAsync(String, CallSettings)

GlobalForwardingRulesClient.Delete(String, String, CallSettings)

GlobalForwardingRulesClient.DeleteAsync(String, String, CallSettings)

GlobalForwardingRulesClient.DeleteAsync(String, String, CancellationToken)

GlobalForwardingRulesClient.GetAsync(GetGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.Get(String, String, CallSettings)

GlobalForwardingRulesClient.GetAsync(String, String, CallSettings)

GlobalForwardingRulesClient.GetAsync(String, String, CancellationToken)

GlobalForwardingRulesClient.InsertAsync(InsertGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.PollOnceInsert(String, CallSettings)

GlobalForwardingRulesClient.PollOnceInsertAsync(String, CallSettings)

GlobalForwardingRulesClient.Insert(String, ForwardingRule, CallSettings)

GlobalForwardingRulesClient.InsertAsync(String, ForwardingRule, CallSettings)

GlobalForwardingRulesClient.InsertAsync(String, ForwardingRule, CancellationToken)

GlobalForwardingRulesClient.List(String, String, Nullable<Int32>, CallSettings)

GlobalForwardingRulesClient.ListAsync(String, String, Nullable<Int32>, CallSettings)

GlobalForwardingRulesClient.PatchAsync(PatchGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.PollOncePatch(String, CallSettings)

GlobalForwardingRulesClient.PollOncePatchAsync(String, CallSettings)

GlobalForwardingRulesClient.Patch(String, String, ForwardingRule, CallSettings)

GlobalForwardingRulesClient.PatchAsync(String, String, ForwardingRule, CallSettings)

GlobalForwardingRulesClient.PatchAsync(String, String, ForwardingRule, CancellationToken)

GlobalForwardingRulesClient.SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.PollOnceSetLabels(String, CallSettings)

GlobalForwardingRulesClient.PollOnceSetLabelsAsync(String, CallSettings)

GlobalForwardingRulesClient.SetLabels(String, String, GlobalSetLabelsRequest, CallSettings)

GlobalForwardingRulesClient.SetLabelsAsync(String, String, GlobalSetLabelsRequest, CallSettings)

GlobalForwardingRulesClient.SetLabelsAsync(String, String, GlobalSetLabelsRequest, CancellationToken)

GlobalForwardingRulesClient.SetTargetAsync(SetTargetGlobalForwardingRuleRequest, CancellationToken)

GlobalForwardingRulesClient.PollOnceSetTarget(String, CallSettings)

GlobalForwardingRulesClient.PollOnceSetTargetAsync(String, CallSettings)

GlobalForwardingRulesClient.SetTarget(String, String, TargetReference, CallSettings)

GlobalForwardingRulesClient.SetTargetAsync(String, String, TargetReference, CallSettings)

GlobalForwardingRulesClient.SetTargetAsync(String, String, TargetReference, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The GlobalForwardingRules API.

Constructors

GlobalForwardingRulesClientImpl(GlobalForwardingRules.GlobalForwardingRulesClient, GlobalForwardingRulesSettings, ILogger)

public GlobalForwardingRulesClientImpl(GlobalForwardingRules.GlobalForwardingRulesClient grpcClient, GlobalForwardingRulesSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	GlobalForwardingRules.GlobalForwardingRulesClient The underlying gRPC client.
settings	GlobalForwardingRulesSettings The base GlobalForwardingRulesSettings 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

GlobalForwardingRulesClient.DeleteOperationsClient

GrpcClient

public override GlobalForwardingRules.GlobalForwardingRulesClient GrpcClient { get; }

The underlying gRPC GlobalForwardingRules client

Property Value
Type	Description
GlobalForwardingRules.GlobalForwardingRulesClient

Overrides

GlobalForwardingRulesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

GlobalForwardingRulesClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

GlobalForwardingRulesClient.PatchOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
OperationsClient

Overrides

GlobalForwardingRulesClient.SetLabelsOperationsClient

SetTargetOperationsClient

public override OperationsClient SetTargetOperationsClient { get; }

The long-running operations client for SetTarget.

Property Value
Type	Description
OperationsClient

Overrides

GlobalForwardingRulesClient.SetTargetOperationsClient

Methods

Delete(DeleteGlobalForwardingRuleRequest, CallSettings)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
Name	Description
request	DeleteGlobalForwardingRuleRequest 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
Operation<Operation, Operation>	The RPC response.

Overrides

GlobalForwardingRulesClient.Delete(DeleteGlobalForwardingRuleRequest, CallSettings)

DeleteAsync(DeleteGlobalForwardingRuleRequest, CallSettings)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
Name	Description
request	DeleteGlobalForwardingRuleRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.DeleteAsync(DeleteGlobalForwardingRuleRequest, CallSettings)

Get(GetGlobalForwardingRuleRequest, CallSettings)

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

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Parameters
Name	Description
request	GetGlobalForwardingRuleRequest 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

GlobalForwardingRulesClient.Get(GetGlobalForwardingRuleRequest, CallSettings)

GetAsync(GetGlobalForwardingRuleRequest, CallSettings)

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

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

Parameters
Name	Description
request	GetGlobalForwardingRuleRequest 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
Task<ForwardingRule>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.GetAsync(GetGlobalForwardingRuleRequest, CallSettings)

Insert(InsertGlobalForwardingRuleRequest, CallSettings)

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

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertGlobalForwardingRuleRequest 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
Operation<Operation, Operation>	The RPC response.

Overrides

GlobalForwardingRulesClient.Insert(InsertGlobalForwardingRuleRequest, CallSettings)

InsertAsync(InsertGlobalForwardingRuleRequest, CallSettings)

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

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

Parameters
Name	Description
request	InsertGlobalForwardingRuleRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.InsertAsync(InsertGlobalForwardingRuleRequest, CallSettings)

List(ListGlobalForwardingRulesRequest, CallSettings)

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

Retrieves a list of GlobalForwardingRule resources available to the specified project.

Parameters
Name	Description
request	ListGlobalForwardingRulesRequest 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
PagedEnumerable<ForwardingRuleList, ForwardingRule>	A pageable sequence of ForwardingRule resources.

Overrides

GlobalForwardingRulesClient.List(ListGlobalForwardingRulesRequest, CallSettings)

ListAsync(ListGlobalForwardingRulesRequest, CallSettings)

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

Retrieves a list of GlobalForwardingRule resources available to the specified project.

Parameters
Name	Description
request	ListGlobalForwardingRulesRequest 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
PagedAsyncEnumerable<ForwardingRuleList, ForwardingRule>	A pageable asynchronous sequence of ForwardingRule resources.

Overrides

GlobalForwardingRulesClient.ListAsync(ListGlobalForwardingRulesRequest, CallSettings)

Patch(PatchGlobalForwardingRuleRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchGlobalForwardingRuleRequest 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	PatchGlobalForwardingRuleRequest 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
Operation<Operation, Operation>	The RPC response.

Overrides

GlobalForwardingRulesClient.Patch(PatchGlobalForwardingRuleRequest, CallSettings)

PatchAsync(PatchGlobalForwardingRuleRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> PatchAsync(PatchGlobalForwardingRuleRequest 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	PatchGlobalForwardingRuleRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.PatchAsync(PatchGlobalForwardingRuleRequest, CallSettings)

SetLabels(SetLabelsGlobalForwardingRuleRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsGlobalForwardingRuleRequest 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	SetLabelsGlobalForwardingRuleRequest 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
Operation<Operation, Operation>	The RPC response.

Overrides

GlobalForwardingRulesClient.SetLabels(SetLabelsGlobalForwardingRuleRequest, CallSettings)

SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest 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	SetLabelsGlobalForwardingRuleRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest, CallSettings)

SetTarget(SetTargetGlobalForwardingRuleRequest, CallSettings)

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

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

Parameters
Name	Description
request	SetTargetGlobalForwardingRuleRequest 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
Operation<Operation, Operation>	The RPC response.

Overrides

GlobalForwardingRulesClient.SetTarget(SetTargetGlobalForwardingRuleRequest, CallSettings)

SetTargetAsync(SetTargetGlobalForwardingRuleRequest, CallSettings)

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

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

Parameters
Name	Description
request	SetTargetGlobalForwardingRuleRequest 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
Task<Operation<Operation, Operation>>	A Task containing the RPC response.

Overrides

GlobalForwardingRulesClient.SetTargetAsync(SetTargetGlobalForwardingRuleRequest, CallSettings)