Class ServicesResource

The "services" collection of methods.

Inheritance

object

ServicesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ServiceControl.v1

Assembly: Google.Apis.ServiceControl.v1.dll

Syntax

public class ServicesResource

Constructors

ServicesResource(IClientService)

Constructs a new resource.

Declaration

public ServicesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AllocateQuota(AllocateQuotaRequest, string)

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.

Declaration

public virtual ServicesResource.AllocateQuotaRequest AllocateQuota(AllocateQuotaRequest body, string serviceName)

Parameters

Type	Name	Description
AllocateQuotaRequest	body	The body of the request.
string	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.

Returns

Type	Description
ServicesResource.AllocateQuotaRequest

Check(CheckRequest, string)

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.

Declaration

public virtual ServicesResource.CheckRequest Check(CheckRequest body, string serviceName)

Parameters

Type	Name	Description
CheckRequest	body	The body of the request.
string	serviceName	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.

Returns

Type	Description
ServicesResource.CheckRequest

Report(ReportRequest, string)

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.

Declaration

public virtual ServicesResource.ReportRequest Report(ReportRequest body, string serviceName)

Parameters

Type	Name	Description
ReportRequest	body	The body of the request.
string	serviceName	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.

Returns

Type	Description
ServicesResource.ReportRequest