google_api_service_management v0.1.0 GoogleApi.ServiceManagement.V1.Api.Operations View Source

API calls for all endpoints tagged Operations.

Link to this section 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

Lists service operations that match the specified filter in the request

Link to this section Functions

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

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 (GoogleApi.ServiceManagement.V1.Connection): Connection to server
  • name (String.t): The name of the operation resource.
  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :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.

Returns

{:ok, %GoogleApi.ServiceManagement.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function servicemanagement_operations_list(connection, opts \\ []) View Source
servicemanagement_operations_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.ServiceManagement.V1.Model.ListOperationsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists service operations that match the specified filter in the request.

Parameters

  • connection (GoogleApi.ServiceManagement.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :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.
    • :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.
    • :filter (String.t): A string for filtering Operations. The following filter fields are supported&#58; serviceName&#58; Required. Only `=` operator is allowed. startTime&#58; The time this job was started, in ISO 8601 format. Allowed operators are `>=`, `>`, `<=`, and `<`. status&#58; Can be `done`, `in_progress`, or `failed`. Allowed operators are `=`, and `!=`. Filter expression supports conjunction (AND) and disjunction (OR) logical operators. However, the serviceName restriction must be at the top-level and can only be combined with other restrictions via the AND logical operator. Examples&#58; `serviceName={some-service}.googleapis.com` `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` `serviceName={some-service}.googleapis.com AND status=done` * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
    • :name (String.t): Not used.
    • :pageToken (String.t): The standard list page token.
    • :pageSize (integer()): The maximum number of operations to return. If unspecified, defaults to 50. The maximum value is 100.

Returns

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