Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.ServiceControl.Services.AllocateQuota

Contents

REST Resource
Creating a Request
Request Lenses

Description

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.

See: Service Control API Reference for servicecontrol.services.allocateQuota.

Synopsis

type ServicesAllocateQuotaResource = "v1" :> ("services" :> (CaptureMode "serviceName" "allocateQuota" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AllocateQuotaRequest :> Post '[JSON] AllocateQuotaResponse)))))))))
servicesAllocateQuota :: AllocateQuotaRequest -> Text -> ServicesAllocateQuota
data ServicesAllocateQuota
saqXgafv :: Lens' ServicesAllocateQuota (Maybe Xgafv)
saqUploadProtocol :: Lens' ServicesAllocateQuota (Maybe Text)
saqAccessToken :: Lens' ServicesAllocateQuota (Maybe Text)
saqUploadType :: Lens' ServicesAllocateQuota (Maybe Text)
saqPayload :: Lens' ServicesAllocateQuota AllocateQuotaRequest
saqServiceName :: Lens' ServicesAllocateQuota Text
saqCallback :: Lens' ServicesAllocateQuota (Maybe Text)

REST Resource

type ServicesAllocateQuotaResource = "v1" :> ("services" :> (CaptureMode "serviceName" "allocateQuota" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AllocateQuotaRequest :> Post '[JSON] AllocateQuotaResponse))))))))) Source #

A resource alias for servicecontrol.services.allocateQuota method which the ServicesAllocateQuota request conforms to.

Creating a Request

servicesAllocateQuota Source #

Arguments

:: AllocateQuotaRequest	`saqPayload`
-> Text	`saqServiceName`
-> ServicesAllocateQuota

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

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

data ServicesAllocateQuota Source #

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.

See: servicesAllocateQuota smart constructor.

Instances

Eq ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota Methods (==) :: ServicesAllocateQuota -> ServicesAllocateQuota -> Bool # (/=) :: ServicesAllocateQuota -> ServicesAllocateQuota -> Bool #
Data ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ServicesAllocateQuota -> c ServicesAllocateQuota # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ServicesAllocateQuota # toConstr :: ServicesAllocateQuota -> Constr # dataTypeOf :: ServicesAllocateQuota -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ServicesAllocateQuota) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ServicesAllocateQuota) # gmapT :: (forall b. Data b => b -> b) -> ServicesAllocateQuota -> ServicesAllocateQuota # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ServicesAllocateQuota -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ServicesAllocateQuota -> r # gmapQ :: (forall d. Data d => d -> u) -> ServicesAllocateQuota -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ServicesAllocateQuota -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ServicesAllocateQuota -> m ServicesAllocateQuota # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ServicesAllocateQuota -> m ServicesAllocateQuota # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ServicesAllocateQuota -> m ServicesAllocateQuota #
Show ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota Methods showsPrec :: Int -> ServicesAllocateQuota -> ShowS # show :: ServicesAllocateQuota -> String # showList :: [ServicesAllocateQuota] -> ShowS #
Generic ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota Associated Types type Rep ServicesAllocateQuota :: Type -> Type # Methods from :: ServicesAllocateQuota -> Rep ServicesAllocateQuota x # to :: Rep ServicesAllocateQuota x -> ServicesAllocateQuota #
GoogleRequest ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota Associated Types type Rs ServicesAllocateQuota :: Type # type Scopes ServicesAllocateQuota :: [Symbol] # Methods requestClient :: ServicesAllocateQuota -> GClient (Rs ServicesAllocateQuota) #
type Rep ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota type Rep ServicesAllocateQuota = D1 (MetaData "ServicesAllocateQuota" "Network.Google.Resource.ServiceControl.Services.AllocateQuota" "gogol-servicecontrol-0.4.0-7Bdn4PUGU21DcIBLYz37iX" False) (C1 (MetaCons "ServicesAllocateQuota'" PrefixI True) ((S1 (MetaSel (Just "_saqXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_saqUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_saqAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_saqUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_saqPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AllocateQuotaRequest)) :: (S1 (MetaSel (Just "_saqServiceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_saqCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota type Scopes ServicesAllocateQuota = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/servicecontrol" ': ([] :: [Symbol]))
type Rs ServicesAllocateQuota Source #
Instance details Defined in Network.Google.Resource.ServiceControl.Services.AllocateQuota type Rs ServicesAllocateQuota = AllocateQuotaResponse

Request Lenses

saqXgafv :: Lens' ServicesAllocateQuota (Maybe Xgafv) Source #

V1 error format.

saqUploadProtocol :: Lens' ServicesAllocateQuota (Maybe Text) Source #

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

saqAccessToken :: Lens' ServicesAllocateQuota (Maybe Text) Source #

OAuth access token.

saqUploadType :: Lens' ServicesAllocateQuota (Maybe Text) Source #

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

saqPayload :: Lens' ServicesAllocateQuota AllocateQuotaRequest Source #

Multipart request metadata.

saqServiceName :: Lens' ServicesAllocateQuota Text Source #

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.

saqCallback :: Lens' ServicesAllocateQuota (Maybe Text) Source #

JSONP