Network.Google.Resource.ServiceControl.Services.Check

Checks an operation with Google Service Control to decide whether the given operation should proceed. It should 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 server errors, the client can rely on the cached results for longer time. 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 Google Cloud IAM.

See: Google Service Control API Reference for servicecontrol.services.check.

REST Resource

type ServicesCheckResource = "v1" :> ("services" :> (CaptureMode "serviceName" "check" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CheckRequest :> Post '[JSON] CheckResponse)))))))))))

A resource alias for servicecontrol.services.check method which the ServicesCheck request conforms to.

Creating a Request

servicesCheck

Arguments

:: CheckRequest

scPayload

-> Text

scServiceName

-> ServicesCheck

Creates a value of ServicesCheck with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scXgafv
• scUploadProtocol
• scPp
• scAccessToken
• scUploadType
• scPayload
• scBearerToken
• scServiceName
• scCallback

data ServicesCheck

Checks an operation with Google Service Control to decide whether the given operation should proceed. It should 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 server errors, the client can rely on the cached results for longer time. 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 Google Cloud IAM.

See: servicesCheck smart constructor.

Instances

Eq ServicesCheck

Methods

(==) :: ServicesCheck -> ServicesCheck -> Bool

(/=) :: ServicesCheck -> ServicesCheck -> Bool

Data ServicesCheck

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ServicesCheck -> c ServicesCheck

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ServicesCheck

toConstr :: ServicesCheck -> Constr

dataTypeOf :: ServicesCheck -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ServicesCheck)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ServicesCheck)

gmapT :: (forall b. Data b => b -> b) -> ServicesCheck -> ServicesCheck

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ServicesCheck -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ServicesCheck -> r

gmapQ :: (forall d. Data d => d -> u) -> ServicesCheck -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ServicesCheck -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ServicesCheck -> m ServicesCheck

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ServicesCheck -> m ServicesCheck

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ServicesCheck -> m ServicesCheck

Show ServicesCheck

Methods

showsPrec :: Int -> ServicesCheck -> ShowS

show :: ServicesCheck -> String

showList :: [ServicesCheck] -> ShowS

Generic ServicesCheck

Associated Types

type Rep ServicesCheck :: * -> *

Methods

from :: ServicesCheck -> Rep ServicesCheck x

to :: Rep ServicesCheck x -> ServicesCheck

GoogleRequest ServicesCheck

Associated Types

type Rs ServicesCheck :: *

type Scopes ServicesCheck :: [Symbol]

Methods

requestClient :: ServicesCheck -> Client (Rs ServicesCheck)

type Rep ServicesCheck

type Rep ServicesCheck = D1 (MetaData "ServicesCheck" "Network.Google.Resource.ServiceControl.Services.Check" "gogol-servicecontrol-0.2.0-4GcnhH9w9PILezs7rEuw3Y" False) (C1 (MetaCons "ServicesCheck'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) (S1 (MetaSel (Just Symbol "_scUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_scPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_scAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CheckRequest))) ((:*:) (S1 (MetaSel (Just Symbol "_scBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_scServiceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_scCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes ServicesCheck

type Scopes ServicesCheck = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/servicecontrol" ([] Symbol))

type Rs ServicesCheck

type Rs ServicesCheck = CheckResponse

Request Lenses

scXgafv :: Lens' ServicesCheck (Maybe Xgafv)

V1 error format.

scUploadProtocol :: Lens' ServicesCheck (Maybe Text)

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

scPp :: Lens' ServicesCheck Bool

Pretty-print response.

scAccessToken :: Lens' ServicesCheck (Maybe Text)

OAuth access token.

scUploadType :: Lens' ServicesCheck (Maybe Text)

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

scPayload :: Lens' ServicesCheck CheckRequest

Multipart request metadata.

scBearerToken :: Lens' ServicesCheck (Maybe Text)

OAuth bearer token.

scServiceName :: Lens' ServicesCheck Text

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.

scCallback :: Lens' ServicesCheck (Maybe Text)

JSONP