Googly.CloudVision.Locations.Operations (googly_cloud_vision v0.1.0)

Copy Markdown View Source

Endpoints for the Locations.Operations resource.

Summary

Functions

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Functions

get(name, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, Googly.CloudVision.Model.Operation.t()} | {:error, term()}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • name (type: String.t()) - The name of the operation resource.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • access_token (type: String.t()) - OAuth access token.
    • alt (type: String.t()) - Data format for response.
    • callback (type: String.t()) - JSONP
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: 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.
    • oauth_token (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: 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.
    • upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
    • upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
    • xgafv (type: String.t()) - V1 error format.

Returns

  • {:ok, %Googly.CloudVision.Model.Operation{}} on success
  • {:error, %Googly.CloudVision.Error{}} on failure