Show / Hide Table of Contents

Class ServicesResource.CheckRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CheckResponse>
ServiceControlBaseServiceRequest<CheckResponse>
ServicesResource.CheckRequest
Implements
IClientServiceRequest<CheckResponse>
IClientServiceRequest
Inherited Members
ServiceControlBaseServiceRequest<CheckResponse>.Xgafv
ServiceControlBaseServiceRequest<CheckResponse>.AccessToken
ServiceControlBaseServiceRequest<CheckResponse>.Alt
ServiceControlBaseServiceRequest<CheckResponse>.Callback
ServiceControlBaseServiceRequest<CheckResponse>.Fields
ServiceControlBaseServiceRequest<CheckResponse>.Key
ServiceControlBaseServiceRequest<CheckResponse>.OauthToken
ServiceControlBaseServiceRequest<CheckResponse>.PrettyPrint
ServiceControlBaseServiceRequest<CheckResponse>.QuotaUser
ServiceControlBaseServiceRequest<CheckResponse>.UploadType
ServiceControlBaseServiceRequest<CheckResponse>.UploadProtocol
ClientServiceRequest<CheckResponse>.Execute()
ClientServiceRequest<CheckResponse>.ExecuteAsStream()
ClientServiceRequest<CheckResponse>.ExecuteAsync()
ClientServiceRequest<CheckResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<CheckResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<CheckResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<CheckResponse>.CreateRequest(bool?)
ClientServiceRequest<CheckResponse>.GenerateRequestUri()
ClientServiceRequest<CheckResponse>.GetDefaultETagAction(string)
ClientServiceRequest<CheckResponse>.ETagAction
ClientServiceRequest<CheckResponse>.ModifyRequest
ClientServiceRequest<CheckResponse>.ValidateParameters
ClientServiceRequest<CheckResponse>.ApiVersion
ClientServiceRequest<CheckResponse>.RequestParameters
ClientServiceRequest<CheckResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
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.CheckRequest : ServiceControlBaseServiceRequest<CheckResponse>, IClientServiceRequest<CheckResponse>, IClientServiceRequest

Constructors

CheckRequest(IClientService, CheckRequest, string)

Constructs a new Check request.

Declaration
public CheckRequest(IClientService service, CheckRequest body, string serviceName)
Parameters
Type Name Description
IClientService service
CheckRequest body
string serviceName

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<CheckResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<CheckResponse>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<CheckResponse>.RestPath

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.

Declaration
[RequestParameter("serviceName", RequestParameterType.Path)]
public virtual string ServiceName { get; }
Property Value
Type Description
string

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<CheckResponse>.GetBody()

InitParameters()

Initializes Check parameter list.

Declaration
protected override void InitParameters()
Overrides
ServiceControlBaseServiceRequest<CheckResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX