Service Control v1 API - Class QuotaController.QuotaControllerClient (2.4.0)

public class QuotaController.QuotaControllerClient : ClientBase<QuotaController.QuotaControllerClient>

Reference documentation and code samples for the Service Control v1 API class QuotaController.QuotaControllerClient.

Client for QuotaController

Inheritance

object > ClientBase > ClientBaseQuotaControllerQuotaControllerClient > QuotaController.QuotaControllerClient

Namespace

Google.Cloud.ServiceControl.V1

Assembly

Google.Cloud.ServiceControl.V1.dll

Constructors

QuotaControllerClient()

protected QuotaControllerClient()

Protected parameterless constructor to allow creation of test doubles.

QuotaControllerClient(CallInvoker)

public QuotaControllerClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

QuotaControllerClient(ChannelBase)

public QuotaControllerClient(ChannelBase channel)

Creates a new client for QuotaController

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

QuotaControllerClient(ClientBaseConfiguration)

protected QuotaControllerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AllocateQuota(AllocateQuotaRequest, CallOptions)

public virtual AllocateQuotaResponse AllocateQuota(AllocateQuotaRequest request, CallOptions options)

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.

This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM.

NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Parameters
Name Description
request AllocateQuotaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AllocateQuotaResponse

The response received from the server.

AllocateQuota(AllocateQuotaRequest, Metadata, DateTime?, CancellationToken)

public virtual AllocateQuotaResponse AllocateQuota(AllocateQuotaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.

This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM.

NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Parameters
Name Description
request AllocateQuotaRequest

The request to send to the server.

headers Metadata

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

deadline 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
AllocateQuotaResponse

The response received from the server.

AllocateQuotaAsync(AllocateQuotaRequest, CallOptions)

public virtual AsyncUnaryCall<AllocateQuotaResponse> AllocateQuotaAsync(AllocateQuotaRequest request, CallOptions options)

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.

This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM.

NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Parameters
Name Description
request AllocateQuotaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAllocateQuotaResponse

The call object.

AllocateQuotaAsync(AllocateQuotaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AllocateQuotaResponse> AllocateQuotaAsync(AllocateQuotaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.

This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM.

NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Parameters
Name Description
request AllocateQuotaRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallAllocateQuotaResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override QuotaController.QuotaControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
QuotaControllerQuotaControllerClient
Overrides