Network.Google.Resource.ServiceControl.Services.Check

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.

See: 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 "access_token" Text :> (QueryParam "uploadType" 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
• scAccessToken
• scUploadType
• scPayload
• scServiceName
• scCallback

data ServicesCheck

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.

See: servicesCheck smart constructor.

Instances

Eq ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

Methods

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

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

Data ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

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

Defined in Network.Google.Resource.ServiceControl.Services.Check

Methods

showsPrec :: Int -> ServicesCheck -> ShowS

show :: ServicesCheck -> String

showList :: [ServicesCheck] -> ShowS

Generic ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

Associated Types

type Rep ServicesCheck :: Type -> Type

Methods

from :: ServicesCheck -> Rep ServicesCheck x

to :: Rep ServicesCheck x -> ServicesCheck

GoogleRequest ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

Associated Types

type Rs ServicesCheck :: Type

type Scopes ServicesCheck :: [Symbol]

Methods

requestClient :: ServicesCheck -> GClient (Rs ServicesCheck)

type Rep ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

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

type Scopes ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

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

type Rs ServicesCheck

Defined in Network.Google.Resource.ServiceControl.Services.Check

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").

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.

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