Class ServiceControllerClient (2.21.0-rc)

Lets clients check and report operations 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

ServiceControllerClient(ServiceControllerClient const &)

Copy and move support

Parameter
NameDescription
ServiceControllerClient const &

ServiceControllerClient(ServiceControllerClient &&)

Copy and move support

Parameter
NameDescription
ServiceControllerClient &&

ServiceControllerClient(std::shared_ptr< ServiceControllerConnection >, Options)

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

Operators

operator=(ServiceControllerClient const &)

Copy and move support

Parameter
NameDescription
ServiceControllerClient const &
Returns
TypeDescription
ServiceControllerClient &

operator=(ServiceControllerClient &&)

Copy and move support

Parameter
NameDescription
ServiceControllerClient &&
Returns
TypeDescription
ServiceControllerClient &

Functions

Check(google::api::servicecontrol::v1::CheckRequest const &, Options)

Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies.

It must be called before the operation is executed.

If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the Check method having the latest policy information.

NOTE: the CheckRequest has the size limit (wire-format byte size) of 1MB.

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

Parameters
NameDescription
request google::api::servicecontrol::v1::CheckRequest 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.CheckRequest. 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::CheckResponse >

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

Report(google::api::servicecontrol::v1::ReportRequest const &, Options)

Reports operation results to Google Service Control, such as logs and metrics.

It should be called after an operation is completed.

If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons.

NOTE: the ReportRequest has the size limit (wire-format byte size) of 1MB.

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

Parameters
NameDescription
request google::api::servicecontrol::v1::ReportRequest 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.ReportRequest. 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::ReportResponse >

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