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

Synopsis

type ProjectsInstancesDatabasesOperationsCancelResource = "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)))))))
projectsInstancesDatabasesOperationsCancel :: Text -> ProjectsInstancesDatabasesOperationsCancel
data ProjectsInstancesDatabasesOperationsCancel
pidocXgafv :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Xgafv)
pidocUploadProtocol :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text)
pidocAccessToken :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text)
pidocUploadType :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text)
pidocName :: Lens' ProjectsInstancesDatabasesOperationsCancel Text
pidocCallback :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text)

REST Resource

type ProjectsInstancesDatabasesOperationsCancelResource = "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.databases.operations.cancel method which the ProjectsInstancesDatabasesOperationsCancel request conforms to.

Creating a Request

projectsInstancesDatabasesOperationsCancel Source #

Arguments

:: Text	`pidocName`
-> ProjectsInstancesDatabasesOperationsCancel

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

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

data ProjectsInstancesDatabasesOperationsCancel 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: projectsInstancesDatabasesOperationsCancel smart constructor.

Instances

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

Request Lenses

pidocXgafv :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Xgafv) Source #

V1 error format.

pidocUploadProtocol :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text) Source #

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

pidocAccessToken :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text) Source #

OAuth access token.

pidocUploadType :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text) Source #

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

pidocName :: Lens' ProjectsInstancesDatabasesOperationsCancel Text Source #

The name of the operation resource to be cancelled.

pidocCallback :: Lens' ProjectsInstancesDatabasesOperationsCancel (Maybe Text) Source #

JSONP