| Copyright | (c) 2015 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.Genomics.Operations.Cancel
Description
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.
See: API Reference for genomics.operations.cancel.
- type OperationsCancelResource = "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 :> (ReqBody `[JSON]` CancelOperationRequest :> Post `[JSON]` Empty))))))))))
- operationsCancel :: CancelOperationRequest -> Text -> OperationsCancel
- data OperationsCancel
- ocXgafv :: Lens' OperationsCancel (Maybe Text)
- ocUploadProtocol :: Lens' OperationsCancel (Maybe Text)
- ocPp :: Lens' OperationsCancel Bool
- ocAccessToken :: Lens' OperationsCancel (Maybe Text)
- ocUploadType :: Lens' OperationsCancel (Maybe Text)
- ocPayload :: Lens' OperationsCancel CancelOperationRequest
- ocBearerToken :: Lens' OperationsCancel (Maybe Text)
- ocName :: Lens' OperationsCancel Text
- ocCallback :: Lens' OperationsCancel (Maybe Text)
REST Resource
type OperationsCancelResource = "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 :> (ReqBody `[JSON]` CancelOperationRequest :> Post `[JSON]` Empty)))))))))) Source
A resource alias for genomics.operations.cancel method which the
OperationsCancel request conforms to.
Creating a Request
Arguments
| :: CancelOperationRequest | |
| -> Text | |
| -> 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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.
See: operationsCancel smart constructor.
Request Lenses
ocUploadProtocol :: Lens' OperationsCancel (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
ocPp :: Lens' OperationsCancel Bool Source
Pretty-print response.
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.
ocBearerToken :: Lens' OperationsCancel (Maybe Text) Source
OAuth bearer token.
ocName :: Lens' OperationsCancel Text Source
The name of the operation resource to be cancelled.
ocCallback :: Lens' OperationsCancel (Maybe Text) Source
JSONP