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.Spanner.Projects.Instances.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 Spanner API Reference for spanner.projects.instances.operations.cancel.

Synopsis

type ProjectsInstancesOperationsCancelResource = "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)))))))
projectsInstancesOperationsCancel :: Text -> ProjectsInstancesOperationsCancel
data ProjectsInstancesOperationsCancel
piocXgafv :: Lens' ProjectsInstancesOperationsCancel (Maybe Xgafv)
piocUploadProtocol :: Lens' ProjectsInstancesOperationsCancel (Maybe Text)
piocAccessToken :: Lens' ProjectsInstancesOperationsCancel (Maybe Text)
piocUploadType :: Lens' ProjectsInstancesOperationsCancel (Maybe Text)
piocName :: Lens' ProjectsInstancesOperationsCancel Text
piocCallback :: Lens' ProjectsInstancesOperationsCancel (Maybe Text)

REST Resource

type ProjectsInstancesOperationsCancelResource = "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 spanner.projects.instances.operations.cancel method which the ProjectsInstancesOperationsCancel request conforms to.

Creating a Request

projectsInstancesOperationsCancel Source #

Arguments

:: Text	`piocName`
-> ProjectsInstancesOperationsCancel

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

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

data ProjectsInstancesOperationsCancel 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: projectsInstancesOperationsCancel smart constructor.

Instances

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

Request Lenses

piocXgafv :: Lens' ProjectsInstancesOperationsCancel (Maybe Xgafv) Source #

V1 error format.

piocUploadProtocol :: Lens' ProjectsInstancesOperationsCancel (Maybe Text) Source #

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

piocAccessToken :: Lens' ProjectsInstancesOperationsCancel (Maybe Text) Source #

OAuth access token.

piocUploadType :: Lens' ProjectsInstancesOperationsCancel (Maybe Text) Source #

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

piocName :: Lens' ProjectsInstancesOperationsCancel Text Source #

The name of the operation resource to be cancelled.

piocCallback :: Lens' ProjectsInstancesOperationsCancel (Maybe Text) Source #

JSONP