gogol-dataproc-0.4.0: Google Cloud Dataproc SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Contents

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 Dataproc API Reference for dataproc.projects.regions.operations.cancel.

Synopsis

REST Resource

type ProjectsRegionsOperationsCancelResource = "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 dataproc.projects.regions.operations.cancel method which the ProjectsRegionsOperationsCancel request conforms to.

Creating a Request

projectsRegionsOperationsCancel Source #

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

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

data ProjectsRegionsOperationsCancel 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: projectsRegionsOperationsCancel smart constructor.

Instances
Eq ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Data ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsRegionsOperationsCancel -> c ProjectsRegionsOperationsCancel #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsRegionsOperationsCancel #

toConstr :: ProjectsRegionsOperationsCancel -> Constr #

dataTypeOf :: ProjectsRegionsOperationsCancel -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsRegionsOperationsCancel) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsRegionsOperationsCancel) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsRegionsOperationsCancel -> ProjectsRegionsOperationsCancel #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsOperationsCancel -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsOperationsCancel -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsRegionsOperationsCancel -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsRegionsOperationsCancel -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsRegionsOperationsCancel -> m ProjectsRegionsOperationsCancel #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsOperationsCancel -> m ProjectsRegionsOperationsCancel #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsOperationsCancel -> m ProjectsRegionsOperationsCancel #

Show ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Generic ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Associated Types

type Rep ProjectsRegionsOperationsCancel :: Type -> Type #

GoogleRequest ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

type Rep ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

type Rep ProjectsRegionsOperationsCancel = D1 (MetaData "ProjectsRegionsOperationsCancel" "Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel" "gogol-dataproc-0.4.0-1udjiqosCX7iHPt6mLpl8" False) (C1 (MetaCons "ProjectsRegionsOperationsCancel'" PrefixI True) ((S1 (MetaSel (Just "_procXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_procUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_procAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_procUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_procName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_procCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

type Scopes ProjectsRegionsOperationsCancel = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsRegionsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel

Request Lenses

procUploadProtocol :: Lens' ProjectsRegionsOperationsCancel (Maybe Text) Source #

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

procUploadType :: Lens' ProjectsRegionsOperationsCancel (Maybe Text) Source #

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

procName :: Lens' ProjectsRegionsOperationsCancel Text Source #

The name of the operation resource to be cancelled.