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.Datastore.Projects.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 Datastore API Reference for datastore.projects.operations.cancel.

Synopsis

type ProjectsOperationsCancelResource = "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 :> Post '[JSON] Empty)))))))
projectsOperationsCancel :: Text -> ProjectsOperationsCancel
data ProjectsOperationsCancel
pocXgafv :: Lens' ProjectsOperationsCancel (Maybe Xgafv)
pocUploadProtocol :: Lens' ProjectsOperationsCancel (Maybe Text)
pocAccessToken :: Lens' ProjectsOperationsCancel (Maybe Text)
pocUploadType :: Lens' ProjectsOperationsCancel (Maybe Text)
pocName :: Lens' ProjectsOperationsCancel Text
pocCallback :: Lens' ProjectsOperationsCancel (Maybe Text)

REST Resource

type ProjectsOperationsCancelResource = "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 :> Post '[JSON] Empty))))))) Source #

A resource alias for datastore.projects.operations.cancel method which the ProjectsOperationsCancel request conforms to.

Creating a Request

projectsOperationsCancel Source #

Arguments

:: Text	`pocName`
-> ProjectsOperationsCancel

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

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

data ProjectsOperationsCancel 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: projectsOperationsCancel smart constructor.

Instances

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

Request Lenses

pocXgafv :: Lens' ProjectsOperationsCancel (Maybe Xgafv) Source #

V1 error format.

pocUploadProtocol :: Lens' ProjectsOperationsCancel (Maybe Text) Source #

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

pocAccessToken :: Lens' ProjectsOperationsCancel (Maybe Text) Source #

OAuth access token.

pocUploadType :: Lens' ProjectsOperationsCancel (Maybe Text) Source #

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

pocName :: Lens' ProjectsOperationsCancel Text Source #

The name of the operation resource to be cancelled.

pocCallback :: Lens' ProjectsOperationsCancel (Maybe Text) Source #

JSONP