View Source GoogleApi.CloudFunctions.V1.Api.Operations (google_api_cloud_functions v0.37.0)

API calls for all endpoints tagged Operations.

Summary

Functions

cloudfunctions_operations_get(connection, operations_id, optional_params \\ [], opts \\ [])

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.

cloudfunctions_operations_list(connection, optional_params \\ [], opts \\ [])

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Functions

Link to this function

cloudfunctions_operations_get(connection, operations_id, optional_params \\ [], opts \\ [])

View Source 
@spec cloudfunctions_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.CloudFunctions.V1.Connection.t) - Connection to server
  • operations_id (type: String.t) - Part of name. The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudFunctions.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

cloudfunctions_operations_list(connection, optional_params \\ [], opts \\ [])

View Source 
@spec cloudfunctions_operations_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudFunctions.V1.Model.ListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.CloudFunctions.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :name (type: String.t) - The name of the operation's parent resource.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudFunctions.V1.Model.ListOperationsResponse{}} on success
  • {:error, info} on failure