GoogleApi.ServiceManagement.V1.Api.Operations (google_api_service_management v0.56.0) 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, optional_params \\ [], opts \\ [])

View Source

Specs

servicemanagement_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceManagement.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.ServiceManagement.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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.ServiceManagement.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

servicemanagement_operations_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.ServiceManagement.V1.Model.ListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceManagement.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) - A string for filtering Operations. The following filter fields are supported: serviceName: Required. Only = operator is allowed. startTime: The time this job was started, in ISO 8601 format. Allowed operators are >=, >, <=, and <. status: 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: 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 (type: String.t) - Not used.
    • :pageSize (type: integer()) - The maximum number of operations to return. If unspecified, defaults to 50. The maximum value is 100.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

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