com.google.api.services.servicecontrol.v1

Class ServiceControl.Services

java.lang.Object

com.google.api.services.servicecontrol.v1.ServiceControl.Services

Enclosing class:

ServiceControl

public class ServiceControl.Services
extends java.lang.Object

The "services" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceControl.Services.AllocateQuota
class	ServiceControl.Services.Check
class	ServiceControl.Services.Report

Constructor Summary

Constructors

Constructor and Description
Services()

Method Summary

Modifier and Type	Method and Description
ServiceControl.Services.AllocateQuota	allocateQuota(java.lang.String serviceName, AllocateQuotaRequest content) Attempts to allocate quota for the specified consumer.
ServiceControl.Services.Check	check(java.lang.String serviceName, CheckRequest content) Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies.
ServiceControl.Services.Report	report(java.lang.String serviceName, ReportRequest content) Reports operation results to Google Service Control, such as logs and metrics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Services

public Services()

Method Detail

allocateQuota

public ServiceControl.Services.AllocateQuota allocateQuota(java.lang.String serviceName,
                                                           AllocateQuotaRequest content)
                                                    throws java.io.IOException

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](https://cloud.google.com/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. Create a request for the method "services.allocateQuota". This request holds the parameters needed by the servicecontrol server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - Name of the service as specified in the service configuration. For example, `"pubsub.googleapis.com"`. See google.api.Service for the definition of a service name.

content - the AllocateQuotaRequest

Returns:

the request

Throws:

java.io.IOException

check

public ServiceControl.Services.Check check(java.lang.String serviceName,
                                           CheckRequest content)
                                    throws java.io.IOException

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 of 64KB. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Cloud IAM](https://cloud.google.com/iam). Create a request for the method "services.check". This request holds the parameters needed by the servicecontrol server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service- management/reference/rpc/google.api#google.api.Service) for the definition of a service name.

content - the CheckRequest

Returns:

the request

Throws:

java.io.IOException

report

public ServiceControl.Services.Report report(java.lang.String serviceName,
                                             ReportRequest content)
                                      throws java.io.IOException

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](https://cloud.google.com/iam). Create a request for the method "services.report". This request holds the parameters needed by the servicecontrol server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service- management/reference/rpc/google.api#google.api.Service) for the definition of a service name.

content - the ReportRequest

Returns:

the request

Throws:

java.io.IOException