Network.Google.Resource.ServiceUsage.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: Service Usage API Reference for serviceusage.operations.cancel.

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))))))))

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

Creating a Request

operationsCancel

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:

• ocXgafv
• ocUploadProtocol
• ocAccessToken
• ocUploadType
• ocPayload
• ocName
• ocCallback

data OperationsCancel

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

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

Methods

(==) :: OperationsCancel -> OperationsCancel -> Bool

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

Data OperationsCancel

Defined in Network.Google.Resource.ServiceUsage.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

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

Methods

showsPrec :: Int -> OperationsCancel -> ShowS

show :: OperationsCancel -> String

showList :: [OperationsCancel] -> ShowS

Generic OperationsCancel

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

Associated Types

type Rep OperationsCancel :: Type -> Type

Methods

from :: OperationsCancel -> Rep OperationsCancel x

to :: Rep OperationsCancel x -> OperationsCancel

GoogleRequest OperationsCancel

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

Associated Types

type Rs OperationsCancel :: Type

type Scopes OperationsCancel :: [Symbol]

Methods

requestClient :: OperationsCancel -> GClient (Rs OperationsCancel)

type Rep OperationsCancel

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

type Rep OperationsCancel = D1 (MetaData "OperationsCancel" "Network.Google.Resource.ServiceUsage.Operations.Cancel" "gogol-serviceusage-0.4.0-KCQGLbx3xOb2db308f4LnZ" 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

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

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

type Rs OperationsCancel

Defined in Network.Google.Resource.ServiceUsage.Operations.Cancel

type Rs OperationsCancel = Empty

Request Lenses

ocXgafv :: Lens' OperationsCancel (Maybe Xgafv)

V1 error format.

ocUploadProtocol :: Lens' OperationsCancel (Maybe Text)

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

ocAccessToken :: Lens' OperationsCancel (Maybe Text)

OAuth access token.

ocUploadType :: Lens' OperationsCancel (Maybe Text)

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

ocPayload :: Lens' OperationsCancel CancelOperationRequest

Multipart request metadata.

ocName :: Lens' OperationsCancel Text

The name of the operation resource to be cancelled.

ocCallback :: Lens' OperationsCancel (Maybe Text)

JSONP