Compute Engine v1 API - Class GlobalForwardingRules.GlobalForwardingRulesClient (3.2.0)

public class GlobalForwardingRules.GlobalForwardingRulesClient : ClientBase<GlobalForwardingRules.GlobalForwardingRulesClient>

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

Client for GlobalForwardingRules

Inheritance

object > ClientBase > ClientBase GlobalForwardingRules GlobalForwardingRulesClient > GlobalForwardingRules.GlobalForwardingRulesClient

Inherited Members

ClientBase<GlobalForwardingRules.GlobalForwardingRulesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

GlobalForwardingRulesClient()

protected GlobalForwardingRulesClient()

Protected parameterless constructor to allow creation of test doubles.

GlobalForwardingRulesClient(CallInvoker)

public GlobalForwardingRulesClient(CallInvoker callInvoker)

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

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

GlobalForwardingRulesClient(ChannelBase)

public GlobalForwardingRulesClient(ChannelBase channel)

Creates a new client for GlobalForwardingRules

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

GlobalForwardingRulesClient(ClientBaseConfiguration)

protected GlobalForwardingRulesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

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

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

Delete(DeleteGlobalForwardingRuleRequest, CallOptions)

public virtual Operation Delete(DeleteGlobalForwardingRuleRequest request, CallOptions options)

Deletes the specified GlobalForwardingRule resource.

Parameters
Name	Description
`request`	`DeleteGlobalForwardingRuleRequest` 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(DeleteGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
Name	Description
`request`	`DeleteGlobalForwardingRuleRequest` 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(DeleteGlobalForwardingRuleRequest, CallOptions)

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

Deletes the specified GlobalForwardingRule resource.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteAsync(DeleteGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
Name	Description
`request`	`DeleteGlobalForwardingRuleRequest` 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(GetGlobalForwardingRuleRequest, CallOptions)

public virtual ForwardingRule Get(GetGlobalForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`GetGlobalForwardingRuleRequest` 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(GetGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`GetGlobalForwardingRuleRequest` 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(GetGlobalForwardingRuleRequest, CallOptions)

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

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

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

Returns
Type	Description
`AsyncUnaryCallForwardingRule`	The call object.

GetAsync(GetGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`GetGlobalForwardingRuleRequest` 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(InsertGlobalForwardingRuleRequest, CallOptions)

public virtual Operation Insert(InsertGlobalForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`InsertGlobalForwardingRuleRequest` 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(InsertGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`InsertGlobalForwardingRuleRequest` 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(InsertGlobalForwardingRuleRequest, CallOptions)

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

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

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

InsertAsync(InsertGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`InsertGlobalForwardingRuleRequest` 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(ListGlobalForwardingRulesRequest, CallOptions)

public virtual ForwardingRuleList List(ListGlobalForwardingRulesRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`ListGlobalForwardingRulesRequest` 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(ListGlobalForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`ListGlobalForwardingRulesRequest` 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(ListGlobalForwardingRulesRequest, CallOptions)

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

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

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

Returns
Type	Description
`AsyncUnaryCallForwardingRuleList`	The call object.

ListAsync(ListGlobalForwardingRulesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
`request`	`ListGlobalForwardingRulesRequest` 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 GlobalForwardingRules.GlobalForwardingRulesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`GlobalForwardingRulesGlobalForwardingRulesClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.GlobalForwardingRules.GlobalForwardingRulesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchGlobalForwardingRuleRequest, CallOptions)

public virtual Operation Patch(PatchGlobalForwardingRuleRequest 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`	`PatchGlobalForwardingRuleRequest` 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(PatchGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`PatchGlobalForwardingRuleRequest` 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(PatchGlobalForwardingRuleRequest, CallOptions)

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

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

PatchAsync(PatchGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`PatchGlobalForwardingRuleRequest` 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(SetLabelsGlobalForwardingRuleRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsGlobalForwardingRuleRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`SetLabelsGlobalForwardingRuleRequest` 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(SetLabelsGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetLabels(SetLabelsGlobalForwardingRuleRequest 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`	`SetLabelsGlobalForwardingRuleRequest` 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(SetLabelsGlobalForwardingRuleRequest, CallOptions)

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

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

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest 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`	`SetLabelsGlobalForwardingRuleRequest` 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(SetTargetGlobalForwardingRuleRequest, CallOptions)

public virtual Operation SetTarget(SetTargetGlobalForwardingRuleRequest request, CallOptions options)

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

Returns
Type	Description
`Operation`	The response received from the server.

SetTarget(SetTargetGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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 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(SetTargetGlobalForwardingRuleRequest, CallOptions)

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

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

SetTargetAsync(SetTargetGlobalForwardingRuleRequest, Metadata, DateTime?, CancellationToken)

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

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