google_api_vision

v0.1.0

google_api_vision v0.1.0 GoogleApi.Vision.V1.Api.Operations View Source

API calls for all endpoints tagged Operations.

Link to this section Summary

Functions

vision_operations_cancel(connection, name, opts \\ [])

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`

vision_operations_delete(connection, name, opts \\ [])

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`

Link to this section Functions

Link to this function vision_operations_cancel(connection, name, opts \\ []) View Source 
vision_operations_cancel(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

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`.

Parameters

  • connection (GoogleApi.Vision.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource to be cancelled.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :body (CancelOperationRequest):

Returns

{:ok, %GoogleApi.Vision.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function vision_operations_delete(connection, name, opts \\ []) View Source 
vision_operations_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Vision.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

Parameters

  • connection (GoogleApi.Vision.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource to be deleted.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.

Returns

{:ok, %GoogleApi.Vision.V1.Model.Empty{}} on success {:error, info} on failure