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.FireStore.Projects.Databases.Operations.Cancel

Contents

REST Resource
Creating a Request
Request Lenses

Description

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

See: Cloud Firestore API Reference for firestore.projects.databases.operations.cancel.

Synopsis

type ProjectsDatabasesOperationsCancelResource = "v1" :> (CaptureMode "name" "cancel" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleLongrunningCancelOperationRequest :> Post '[JSON] Empty))))))))
projectsDatabasesOperationsCancel :: GoogleLongrunningCancelOperationRequest -> Text -> ProjectsDatabasesOperationsCancel
data ProjectsDatabasesOperationsCancel
pdocXgafv :: Lens' ProjectsDatabasesOperationsCancel (Maybe Xgafv)
pdocUploadProtocol :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text)
pdocAccessToken :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text)
pdocUploadType :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text)
pdocPayload :: Lens' ProjectsDatabasesOperationsCancel GoogleLongrunningCancelOperationRequest
pdocName :: Lens' ProjectsDatabasesOperationsCancel Text
pdocCallback :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text)

REST Resource

type ProjectsDatabasesOperationsCancelResource = "v1" :> (CaptureMode "name" "cancel" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleLongrunningCancelOperationRequest :> Post '[JSON] Empty)))))))) Source #

A resource alias for firestore.projects.databases.operations.cancel method which the ProjectsDatabasesOperationsCancel request conforms to.

Creating a Request

projectsDatabasesOperationsCancel Source #

Arguments

:: GoogleLongrunningCancelOperationRequest	`pdocPayload`
-> Text	`pdocName`
-> ProjectsDatabasesOperationsCancel

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

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

data ProjectsDatabasesOperationsCancel Source #

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

See: projectsDatabasesOperationsCancel smart constructor.

Instances

Eq ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel Methods (==) :: ProjectsDatabasesOperationsCancel -> ProjectsDatabasesOperationsCancel -> Bool # (/=) :: ProjectsDatabasesOperationsCancel -> ProjectsDatabasesOperationsCancel -> Bool #
Data ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesOperationsCancel -> c ProjectsDatabasesOperationsCancel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesOperationsCancel # toConstr :: ProjectsDatabasesOperationsCancel -> Constr # dataTypeOf :: ProjectsDatabasesOperationsCancel -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesOperationsCancel) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesOperationsCancel) # gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesOperationsCancel -> ProjectsDatabasesOperationsCancel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesOperationsCancel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesOperationsCancel -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesOperationsCancel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesOperationsCancel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesOperationsCancel -> m ProjectsDatabasesOperationsCancel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesOperationsCancel -> m ProjectsDatabasesOperationsCancel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesOperationsCancel -> m ProjectsDatabasesOperationsCancel #
Show ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel Methods showsPrec :: Int -> ProjectsDatabasesOperationsCancel -> ShowS # show :: ProjectsDatabasesOperationsCancel -> String # showList :: [ProjectsDatabasesOperationsCancel] -> ShowS #
Generic ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel Associated Types type Rep ProjectsDatabasesOperationsCancel :: Type -> Type # Methods from :: ProjectsDatabasesOperationsCancel -> Rep ProjectsDatabasesOperationsCancel x # to :: Rep ProjectsDatabasesOperationsCancel x -> ProjectsDatabasesOperationsCancel #
GoogleRequest ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel Associated Types type Rs ProjectsDatabasesOperationsCancel :: Type # type Scopes ProjectsDatabasesOperationsCancel :: [Symbol] # Methods requestClient :: ProjectsDatabasesOperationsCancel -> GClient (Rs ProjectsDatabasesOperationsCancel) #
type Rep ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel type Rep ProjectsDatabasesOperationsCancel = D1 (MetaData "ProjectsDatabasesOperationsCancel" "Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesOperationsCancel'" PrefixI True) ((S1 (MetaSel (Just "_pdocXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_pdocUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdocAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pdocUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdocPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleLongrunningCancelOperationRequest)) :: (S1 (MetaSel (Just "_pdocName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pdocCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel type Scopes ProjectsDatabasesOperationsCancel = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesOperationsCancel Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel type Rs ProjectsDatabasesOperationsCancel = Empty

Request Lenses

pdocXgafv :: Lens' ProjectsDatabasesOperationsCancel (Maybe Xgafv) Source #

V1 error format.

pdocUploadProtocol :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text) Source #

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

pdocAccessToken :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text) Source #

OAuth access token.

pdocUploadType :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text) Source #

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

pdocPayload :: Lens' ProjectsDatabasesOperationsCancel GoogleLongrunningCancelOperationRequest Source #

Multipart request metadata.

pdocName :: Lens' ProjectsDatabasesOperationsCancel Text Source #

The name of the operation resource to be cancelled.

pdocCallback :: Lens' ProjectsDatabasesOperationsCancel (Maybe Text) Source #

JSONP