Class ServiceControllerClient (2.18.0)

Private Preview. This feature is only available for approved services.

This API provides admission control and telemetry reporting for services that are integrated with Service Infrastructure.

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::v2::CheckRequest const &, Options)

Private Preview.

This feature is only available for approved services.

This method provides admission control for services that are integrated with Service Infrastructure. It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see Admission Control.

NOTE: The admission control has an expected policy propagation delay of 60s. The caller must not depend on the most recent policy changes.

NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times.

This method requires the servicemanagement.services.check permission on the specified service. For more information, see Service Control API Access Control.

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

the result of the RPC. The response message type (google.api.servicecontrol.v2.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::v2::ReportRequest const &, Options)

Private Preview.

This feature is only available for approved services.

This method provides telemetry reporting for services that are integrated with Service Infrastructure. It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see Telemetry Reporting.

NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call.

This method requires the servicemanagement.services.report permission on the specified service. For more information, see Service Control API Access Control.

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

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