Package google.api.servicecontrol.v2

Index

• ServiceController (interface)
• CheckRequest (message)
• CheckResponse (message)
• ReportRequest (message)
• ReportResponse (message)
• ResourceInfo (message)

ServiceController

Service Control API v2

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.

Check

rpc Check(CheckRequest) returns (CheckResponse) 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. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/servicecontrol https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

Report

rpc Report(ReportRequest) returns (ReportResponse) 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. Authorization Scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/servicecontrol https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

CheckRequest

Request message for the Check method.

Fields
service_name	string The service name as specified in its service configuration. For example, "pubsub.googleapis.com". See google.api.Service for the definition of a service name.
service_config_id	string Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.
attributes	AttributeContext Describes attributes about the operation being executed by the service.
resources[]	ResourceInfo Describes the resources and the policies applied to each resource.

CheckResponse

Response message for the Check method.

Fields
status	Status An 'OK' status allows the operation. Any other status indicates a denial; google.rpc.Status.details would contain additional details about the denial.
headers	map<string, string> Returns a set of request contexts generated from the CheckRequest.

ReportRequest

Request message for the Report method.

Fields
service_name	string The service name as specified in its service configuration. For example, "pubsub.googleapis.com". See google.api.Service for the definition of a service name.
service_config_id	string Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.
operations[]	AttributeContext Describes the list of operations to be reported. Each operation is represented as an AttributeContext, and contains all attributes around an API access.

ReportResponse

Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.

ResourceInfo

Describes a resource referenced in the request.

Fields
name	string The name of the resource referenced in the request.
type	string The resource type in the format of "{service}/{kind}".
permission	string The resource permission needed for this request. The format must be "{service}/{plural}.{verb}".