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

public class 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

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

GlobalForwardingRulesClient(ChannelBase)

public GlobalForwardingRulesClient(ChannelBase channel)

Creates a new client for GlobalForwardingRules

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

GlobalForwardingRulesClient(ClientBase.ClientBaseConfiguration)

protected GlobalForwardingRulesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

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
TypeDescription
Operations.OperationsClient

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
NameDescription
requestDeleteGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
NameDescription
requestDeleteGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified GlobalForwardingRule resource.

Parameters
NameDescription
requestDeleteGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestGetGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ForwardingRule

The response received from the server.

Get(GetGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ForwardingRule>

The call object.

GetAsync(GetGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ForwardingRule>

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
NameDescription
requestInsertGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestInsertGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestListGlobalForwardingRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ForwardingRuleList

The response received from the server.

List(ListGlobalForwardingRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListGlobalForwardingRulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListGlobalForwardingRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ForwardingRuleList>

The call object.

ListAsync(ListGlobalForwardingRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListGlobalForwardingRulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ForwardingRuleList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override GlobalForwardingRules.GlobalForwardingRulesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
GlobalForwardingRules.GlobalForwardingRulesClient
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
NameDescription
requestPatchGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
requestPatchGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchAsync(PatchGlobalForwardingRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(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
NameDescription
requestPatchGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PatchAsync(PatchGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
requestPatchGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestSetLabelsGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabels(SetLabelsGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetLabelsGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetLabelsGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetLabelsAsync(SetLabelsGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetLabelsGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestSetTargetGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTarget(SetTargetGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetTargetGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetTargetGlobalForwardingRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetTargetAsync(SetTargetGlobalForwardingRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetTargetGlobalForwardingRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.