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 |
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
- 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)))))))
- projectsRegionsOperationsCancel :: Text -> ProjectsRegionsOperationsCancel
- data ProjectsRegionsOperationsCancel
- procXgafv :: Lens' ProjectsRegionsOperationsCancel (Maybe Xgafv)
- procUploadProtocol :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)
- procAccessToken :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)
- procUploadType :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)
- procName :: Lens' ProjectsRegionsOperationsCancel Text
- procCallback :: Lens' ProjectsRegionsOperationsCancel (Maybe Text)
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
Request Lenses
procUploadProtocol :: Lens' ProjectsRegionsOperationsCancel (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
procAccessToken :: Lens' ProjectsRegionsOperationsCancel (Maybe Text) Source #
OAuth access token.
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.
procCallback :: Lens' ProjectsRegionsOperationsCancel (Maybe Text) Source #
JSONP