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

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

REST Resource

type ProjectsRegionsOperationsCancelResource = "v1" :> (CaptureMode "name" "cancel" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty)))))))))

A resource alias for dataproc.projects.regions.operations.cancel method which the ProjectsRegionsOperationsCancel request conforms to.

Creating a Request

projectsRegionsOperationsCancel

Arguments

:: Text

procName

-> ProjectsRegionsOperationsCancel

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:

• procXgafv
• procUploadProtocol
• procPp
• procAccessToken
• procUploadType
• procBearerToken
• procName
• procCallback

data ProjectsRegionsOperationsCancel

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

Methods

(==) :: ProjectsRegionsOperationsCancel -> ProjectsRegionsOperationsCancel -> Bool

(/=) :: ProjectsRegionsOperationsCancel -> ProjectsRegionsOperationsCancel -> Bool

Data ProjectsRegionsOperationsCancel

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

Methods

showsPrec :: Int -> ProjectsRegionsOperationsCancel -> ShowS

show :: ProjectsRegionsOperationsCancel -> String

showList :: [ProjectsRegionsOperationsCancel] -> ShowS

Generic ProjectsRegionsOperationsCancel

Associated Types

type Rep ProjectsRegionsOperationsCancel :: * -> *

Methods

from :: ProjectsRegionsOperationsCancel -> Rep ProjectsRegionsOperationsCancel x

to :: Rep ProjectsRegionsOperationsCancel x -> ProjectsRegionsOperationsCancel

GoogleRequest ProjectsRegionsOperationsCancel

Associated Types

type Rs ProjectsRegionsOperationsCancel :: *

type Scopes ProjectsRegionsOperationsCancel :: [Symbol]

Methods

requestClient :: ProjectsRegionsOperationsCancel -> Client (Rs ProjectsRegionsOperationsCancel)

type Rep ProjectsRegionsOperationsCancel

type Rep ProjectsRegionsOperationsCancel = D1 (MetaData "ProjectsRegionsOperationsCancel" "Network.Google.Resource.Dataproc.Projects.Regions.Operations.Cancel" "gogol-dataproc-0.2.0-KcZ0dIGV1joB7pyOCocrVW" False) (C1 (MetaCons "ProjectsRegionsOperationsCancel'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_procXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_procUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_procPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_procAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_procUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_procBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_procName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_procCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ProjectsRegionsOperationsCancel

type Scopes ProjectsRegionsOperationsCancel = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ([] Symbol)

type Rs ProjectsRegionsOperationsCancel

type Rs ProjectsRegionsOperationsCancel = Empty

Request Lenses

procXgafv :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

V1 error format.

procUploadProtocol :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

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

procPp :: Lens' ProjectsRegionsOperationsCancel Bool

Pretty-print response.

procAccessToken :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

OAuth access token.

procUploadType :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

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

procBearerToken :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

OAuth bearer token.

procName :: Lens' ProjectsRegionsOperationsCancel Text

The name of the operation resource to be cancelled.

procCallback :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)

JSONP