Class QuotaControllerClient (2.15.0)

Allows clients to allocate and release quota against a managed service.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

QuotaControllerClient(QuotaControllerClient const &)

Copy and move support

Parameter
NameDescription
QuotaControllerClient const &

QuotaControllerClient(QuotaControllerClient &&)

Copy and move support

Parameter
NameDescription
QuotaControllerClient &&

QuotaControllerClient(std::shared_ptr< QuotaControllerConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< QuotaControllerConnection >
opts Options

Operators

operator=(QuotaControllerClient const &)

Copy and move support

Parameter
NameDescription
QuotaControllerClient const &
Returns
TypeDescription
QuotaControllerClient &

operator=(QuotaControllerClient &&)

Copy and move support

Parameter
NameDescription
QuotaControllerClient &&
Returns
TypeDescription
QuotaControllerClient &

Functions

AllocateQuota(google::api::servicecontrol::v1::AllocateQuotaRequest const &, 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
NameDescription
request google::api::servicecontrol::v1::AllocateQuotaRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.api.servicecontrol.v1.AllocateQuotaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::api::servicecontrol::v1::AllocateQuotaResponse >

the result of the RPC. The response message type (google.api.servicecontrol.v1.AllocateQuotaResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.