com.google.api.services.servicecontrol.v2

Class ServiceControl.Services.Check

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.servicecontrol.v2.ServiceControlRequest<CheckResponse>

com.google.api.services.servicecontrol.v2.ServiceControl.Services.Check

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ServiceControl.Services

public class ServiceControl.Services.Check
extends ServiceControlRequest<CheckResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Check(String serviceName, CheckRequest content) This method provides admission control for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure).

Method Summary

Modifier and Type	Method and Description
String	getServiceName() The service name as specified in its service configuration.
ServiceControl.Services.Check	set(String parameterName, Object value)
ServiceControl.Services.Check	set$Xgafv(String $Xgafv) V1 error format.
ServiceControl.Services.Check	setAccessToken(String accessToken) OAuth access token.
ServiceControl.Services.Check	setAlt(String alt) Data format for response.
ServiceControl.Services.Check	setCallback(String callback) JSONP
ServiceControl.Services.Check	setFields(String fields) Selector specifying which fields to include in a partial response.
ServiceControl.Services.Check	setKey(String key) API key.
ServiceControl.Services.Check	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ServiceControl.Services.Check	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ServiceControl.Services.Check	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ServiceControl.Services.Check	setServiceName(String serviceName) The service name as specified in its service configuration.
ServiceControl.Services.Check	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ServiceControl.Services.Check	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.servicecontrol.v2.ServiceControlRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Check

protected Check(String serviceName,
                CheckRequest content)

This method provides admission control for services that are integrated with [Service Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service- infrastructure/docs/service-control/access-control). Create a request for the method "services.check". This request holds the parameters needed by the the servicecontrol server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ServiceControl.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

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

Since:

1.13

Method Detail

set$Xgafv

public ServiceControl.Services.Check set$Xgafv(String $Xgafv)

Description copied from class: ServiceControlRequest

V1 error format.

Overrides:

set$Xgafv in class ServiceControlRequest<CheckResponse>

setAccessToken

public ServiceControl.Services.Check setAccessToken(String accessToken)

Description copied from class: ServiceControlRequest

OAuth access token.

Overrides:

setAccessToken in class ServiceControlRequest<CheckResponse>

setAlt

public ServiceControl.Services.Check setAlt(String alt)

Description copied from class: ServiceControlRequest

Data format for response.

Overrides:

setAlt in class ServiceControlRequest<CheckResponse>

setCallback

public ServiceControl.Services.Check setCallback(String callback)

Description copied from class: ServiceControlRequest

JSONP

Overrides:

setCallback in class ServiceControlRequest<CheckResponse>

setFields

public ServiceControl.Services.Check setFields(String fields)

Description copied from class: ServiceControlRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ServiceControlRequest<CheckResponse>

setKey

public ServiceControl.Services.Check setKey(String key)

Description copied from class: ServiceControlRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ServiceControlRequest<CheckResponse>

setOauthToken

public ServiceControl.Services.Check setOauthToken(String oauthToken)

Description copied from class: ServiceControlRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ServiceControlRequest<CheckResponse>

setPrettyPrint

public ServiceControl.Services.Check setPrettyPrint(Boolean prettyPrint)

Description copied from class: ServiceControlRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ServiceControlRequest<CheckResponse>

setQuotaUser

public ServiceControl.Services.Check setQuotaUser(String quotaUser)

Description copied from class: ServiceControlRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ServiceControlRequest<CheckResponse>

setUploadType

public ServiceControl.Services.Check setUploadType(String uploadType)

Description copied from class: ServiceControlRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ServiceControlRequest<CheckResponse>

setUploadProtocol

public ServiceControl.Services.Check setUploadProtocol(String uploadProtocol)

Description copied from class: ServiceControlRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ServiceControlRequest<CheckResponse>

getServiceName

public String getServiceName()

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.

setServiceName

public ServiceControl.Services.Check setServiceName(String 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.

set

public ServiceControl.Services.Check set(String parameterName,
                                         Object value)

Overrides:

set in class ServiceControlRequest<CheckResponse>