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: Google Cloud Machine Learning Reference for ml.projects.operations.cancel
.
- type ProjectsOperationsCancelResource = "v1beta1" :> (CaptureMode "name" "cancel" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] GoogleProtobuf__Empty)))))))))
- projectsOperationsCancel :: Text -> ProjectsOperationsCancel
- data ProjectsOperationsCancel
- pocXgafv :: Lens' ProjectsOperationsCancel (Maybe Xgafv)
- pocUploadProtocol :: Lens' ProjectsOperationsCancel (Maybe Text)
- pocPp :: Lens' ProjectsOperationsCancel Bool
- pocAccessToken :: Lens' ProjectsOperationsCancel (Maybe Text)
- pocUploadType :: Lens' ProjectsOperationsCancel (Maybe Text)
- pocBearerToken :: Lens' ProjectsOperationsCancel (Maybe Text)
- pocName :: Lens' ProjectsOperationsCancel Text
- pocCallback :: Lens' ProjectsOperationsCancel (Maybe Text)
REST Resource
type ProjectsOperationsCancelResource = "v1beta1" :> (CaptureMode "name" "cancel" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] GoogleProtobuf__Empty))))))))) Source #
A resource alias for ml.projects.operations.cancel
method which the
ProjectsOperationsCancel
request conforms to.
Creating a Request
projectsOperationsCancel Source #
Creates a value of ProjectsOperationsCancel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsOperationsCancel 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: projectsOperationsCancel
smart constructor.
Request Lenses
pocUploadProtocol :: Lens' ProjectsOperationsCancel (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
pocAccessToken :: Lens' ProjectsOperationsCancel (Maybe Text) Source #
OAuth access token.
pocUploadType :: Lens' ProjectsOperationsCancel (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
pocBearerToken :: Lens' ProjectsOperationsCancel (Maybe Text) Source #
OAuth bearer token.
pocName :: Lens' ProjectsOperationsCancel Text Source #
The name of the operation resource to be cancelled.
pocCallback :: Lens' ProjectsOperationsCancel (Maybe Text) Source #
JSONP