gogol-tpu-0.4.0: Google Cloud TPU 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.TPU.Projects.Locations.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 TPU API Reference for tpu.projects.locations.operations.cancel.

Synopsis

REST Resource

type ProjectsLocationsOperationsCancelResource = "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 tpu.projects.locations.operations.cancel method which the ProjectsLocationsOperationsCancel request conforms to.

Creating a Request

projectsLocationsOperationsCancel Source #

Arguments

:: Text

plocName

-> ProjectsLocationsOperationsCancel 

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

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

data ProjectsLocationsOperationsCancel 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: projectsLocationsOperationsCancel smart constructor.

Instances
Eq ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

Methods

(==) :: ProjectsLocationsOperationsCancel -> ProjectsLocationsOperationsCancel -> Bool #

(/=) :: ProjectsLocationsOperationsCancel -> ProjectsLocationsOperationsCancel -> Bool #

Data ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

Methods

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

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

toConstr :: ProjectsLocationsOperationsCancel -> Constr #

dataTypeOf :: ProjectsLocationsOperationsCancel -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

Methods

showsPrec :: Int -> ProjectsLocationsOperationsCancel -> ShowS #

show :: ProjectsLocationsOperationsCancel -> String #

showList :: [ProjectsLocationsOperationsCancel] -> ShowS #

Generic ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

Associated Types

type Rep ProjectsLocationsOperationsCancel :: Type -> Type #

Methods

from :: ProjectsLocationsOperationsCancel -> Rep ProjectsLocationsOperationsCancel x #

to :: Rep ProjectsLocationsOperationsCancel x -> ProjectsLocationsOperationsCancel #

GoogleRequest ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

Associated Types

type Rs ProjectsLocationsOperationsCancel :: Type #

type Scopes ProjectsLocationsOperationsCancel :: [Symbol] #

Methods

requestClient :: ProjectsLocationsOperationsCancel -> GClient (Rs ProjectsLocationsOperationsCancel) #

type Rep ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

type Rep ProjectsLocationsOperationsCancel = D1 (MetaData "ProjectsLocationsOperationsCancel" "Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel" "gogol-tpu-0.4.0-G6BPhvxEJs5BesDiyU5xd2" False) (C1 (MetaCons "ProjectsLocationsOperationsCancel'" PrefixI True) ((S1 (MetaSel (Just "_plocXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_plocUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plocAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_plocUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_plocName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_plocCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsOperationsCancel Source # 
Instance details

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

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

Defined in Network.Google.Resource.TPU.Projects.Locations.Operations.Cancel

type Rs ProjectsLocationsOperationsCancel = Empty

Request Lenses

plocXgafv :: Lens' ProjectsLocationsOperationsCancel (Maybe Xgafv) Source #

V1 error format.

plocUploadProtocol :: Lens' ProjectsLocationsOperationsCancel (Maybe Text) Source #

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

plocAccessToken :: Lens' ProjectsLocationsOperationsCancel (Maybe Text) Source #

OAuth access token.

plocUploadType :: Lens' ProjectsLocationsOperationsCancel (Maybe Text) Source #

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

plocName :: Lens' ProjectsLocationsOperationsCancel Text Source #

The name of the operation resource to be cancelled.

plocCallback :: Lens' ProjectsLocationsOperationsCancel (Maybe Text) Source #

JSONP