Compute Engine v1 API - Class ForwardingRules.ForwardingRulesClient (3.2.0)

Version latest

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.17.0
• 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 class ForwardingRules.ForwardingRulesClient : ClientBase<ForwardingRules.ForwardingRulesClient>

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

Client for ForwardingRules

Inheritance

object > ClientBase > ClientBaseForwardingRulesForwardingRulesClient > ForwardingRules.ForwardingRulesClient

Inherited Members

ClientBase<ForwardingRules.ForwardingRulesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ForwardingRulesClient()

protected ForwardingRulesClient()

Protected parameterless constructor to allow creation of test doubles.

ForwardingRulesClient(CallInvoker)

public ForwardingRulesClient(CallInvoker callInvoker)

Creates a new client for ForwardingRules that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ForwardingRulesClient(ChannelBase)

public ForwardingRulesClient(ChannelBase channel)

Creates a new client for ForwardingRules

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ForwardingRulesClient(ClientBaseConfiguration)

protected ForwardingRulesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListForwardingRulesRequest, CallOptions)

public virtual ForwardingRuleAggregatedList AggregatedList(AggregatedListForwardingRulesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ForwardingRuleAggregatedList	The response received from the server.

AggregatedList(AggregatedListForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ForwardingRuleAggregatedList AggregatedList(AggregatedListForwardingRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ForwardingRuleAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListForwardingRulesRequest, CallOptions)

public virtual AsyncUnaryCall<ForwardingRuleAggregatedList> AggregatedListAsync(AggregatedListForwardingRulesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallForwardingRuleAggregatedList	The call object.

AggregatedListAsync(AggregatedListForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ForwardingRuleAggregatedList> AggregatedListAsync(AggregatedListForwardingRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallForwardingRuleAggregatedList	The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to RegionOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteForwardingRuleRequest, CallOptions)

public virtual Operation Delete(DeleteForwardingRuleRequest request, CallOptions options)

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
request	DeleteForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
request	DeleteForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteForwardingRuleRequest request, CallOptions options)

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
request	DeleteForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified ForwardingRule resource.

Parameters
Name	Description
request	DeleteForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetForwardingRuleRequest, CallOptions)

public virtual ForwardingRule Get(GetForwardingRuleRequest request, CallOptions options)

Returns the specified ForwardingRule resource.

Parameters
Name	Description
request	GetForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ForwardingRule	The response received from the server.

Get(GetForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual ForwardingRule Get(GetForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified ForwardingRule resource.

Parameters
Name	Description
request	GetForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ForwardingRule	The response received from the server.

GetAsync(GetForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<ForwardingRule> GetAsync(GetForwardingRuleRequest request, CallOptions options)

Returns the specified ForwardingRule resource.

Parameters
Name	Description
request	GetForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallForwardingRule	The call object.

GetAsync(GetForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ForwardingRule> GetAsync(GetForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified ForwardingRule resource.

Parameters
Name	Description
request	GetForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallForwardingRule	The call object.

Insert(InsertForwardingRuleRequest, CallOptions)

public virtual Operation Insert(InsertForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	InsertForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InsertAsync(InsertForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	InsertForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListForwardingRulesRequest, CallOptions)

public virtual ForwardingRuleList List(ListForwardingRulesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListForwardingRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ForwardingRuleList	The response received from the server.

List(ListForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ForwardingRuleList List(ListForwardingRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListForwardingRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ForwardingRuleList	The response received from the server.

ListAsync(ListForwardingRulesRequest, CallOptions)

public virtual AsyncUnaryCall<ForwardingRuleList> ListAsync(ListForwardingRulesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListForwardingRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallForwardingRuleList	The call object.

ListAsync(ListForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ForwardingRuleList> ListAsync(ListForwardingRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListForwardingRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallForwardingRuleList	The call object.

NewInstance(ClientBaseConfiguration)

protected override ForwardingRules.ForwardingRulesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ForwardingRulesForwardingRulesClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.ForwardingRules.ForwardingRulesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchForwardingRuleRequest, CallOptions)

public virtual Operation Patch(PatchForwardingRuleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Patch(PatchForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PatchAsync(PatchForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchForwardingRuleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PatchAsync(PatchForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabels(SetLabelsForwardingRuleRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetLabelsForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabels(SetLabelsForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetLabels(SetLabelsForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetLabelsForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabelsAsync(SetLabelsForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetLabelsForwardingRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetLabelsForwardingRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetTarget(SetTargetForwardingRuleRequest, CallOptions)

public virtual Operation SetTarget(SetTargetForwardingRuleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetTarget(SetTargetForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetTarget(SetTargetForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

SetTargetAsync(SetTargetForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetTargetAsync(SetTargetForwardingRuleRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetTargetAsync(SetTargetForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetTargetAsync(SetTargetForwardingRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.