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.Cloudbuild.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 Build API Reference for cloudbuild.operations.cancel.

Synopsis

type OperationsCancelResource = "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 :> (ReqBody '[JSON] CancelOperationRequest :> Post '[JSON] Empty))))))))
operationsCancel :: CancelOperationRequest -> Text -> OperationsCancel
data OperationsCancel
ocXgafv :: Lens' OperationsCancel (Maybe Xgafv)
ocUploadProtocol :: Lens' OperationsCancel (Maybe Text)
ocAccessToken :: Lens' OperationsCancel (Maybe Text)
ocUploadType :: Lens' OperationsCancel (Maybe Text)
ocPayload :: Lens' OperationsCancel CancelOperationRequest
ocName :: Lens' OperationsCancel Text
ocCallback :: Lens' OperationsCancel (Maybe Text)

REST Resource

type OperationsCancelResource = "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 :> (ReqBody '[JSON] CancelOperationRequest :> Post '[JSON] Empty)))))))) Source #

A resource alias for cloudbuild.operations.cancel method which the OperationsCancel request conforms to.

Creating a Request

operationsCancel Source #

Arguments

:: CancelOperationRequest	`ocPayload`
-> Text	`ocName`
-> OperationsCancel

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

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

data OperationsCancel 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: operationsCancel smart constructor.

Instances

Eq OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel Methods (==) :: OperationsCancel -> OperationsCancel -> Bool # (/=) :: OperationsCancel -> OperationsCancel -> Bool #
Data OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OperationsCancel -> c OperationsCancel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OperationsCancel # toConstr :: OperationsCancel -> Constr # dataTypeOf :: OperationsCancel -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OperationsCancel) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OperationsCancel) # gmapT :: (forall b. Data b => b -> b) -> OperationsCancel -> OperationsCancel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OperationsCancel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OperationsCancel -> r # gmapQ :: (forall d. Data d => d -> u) -> OperationsCancel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OperationsCancel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OperationsCancel -> m OperationsCancel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationsCancel -> m OperationsCancel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationsCancel -> m OperationsCancel #
Show OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel Methods showsPrec :: Int -> OperationsCancel -> ShowS # show :: OperationsCancel -> String # showList :: [OperationsCancel] -> ShowS #
Generic OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel Associated Types type Rep OperationsCancel :: Type -> Type # Methods from :: OperationsCancel -> Rep OperationsCancel x # to :: Rep OperationsCancel x -> OperationsCancel #
GoogleRequest OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel Associated Types type Rs OperationsCancel :: Type # type Scopes OperationsCancel :: [Symbol] # Methods requestClient :: OperationsCancel -> GClient (Rs OperationsCancel) #
type Rep OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel type Rep OperationsCancel = D1 (MetaData "OperationsCancel" "Network.Google.Resource.Cloudbuild.Operations.Cancel" "gogol-containerbuilder-0.4.0-4FzmtZeHoBN7v5WIesnfJp" False) (C1 (MetaCons "OperationsCancel'" PrefixI True) ((S1 (MetaSel (Just "_ocXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_ocUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ocAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ocUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ocPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CancelOperationRequest)) :: (S1 (MetaSel (Just "_ocName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ocCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel type Scopes OperationsCancel = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs OperationsCancel Source #
Instance details Defined in Network.Google.Resource.Cloudbuild.Operations.Cancel type Rs OperationsCancel = Empty

Request Lenses

ocXgafv :: Lens' OperationsCancel (Maybe Xgafv) Source #

V1 error format.

ocUploadProtocol :: Lens' OperationsCancel (Maybe Text) Source #

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

ocAccessToken :: Lens' OperationsCancel (Maybe Text) Source #

OAuth access token.

ocUploadType :: Lens' OperationsCancel (Maybe Text) Source #

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

ocPayload :: Lens' OperationsCancel CancelOperationRequest Source #

Multipart request metadata.

ocName :: Lens' OperationsCancel Text Source #

The name of the operation resource to be cancelled.

ocCallback :: Lens' OperationsCancel (Maybe Text) Source #

JSONP