GoogleApi.SQLAdmin.V1beta4.Api.Operations (google_api_sql_admin v0.71.0)

API calls for all endpoints tagged Operations.

Summary

Functions

sql_operations_cancel(connection, project, operation, optional_params \\ [], opts \\ [])

Cancels an instance operation that has been performed on an instance.

sql_operations_get(connection, project, operation, optional_params \\ [], opts \\ [])

Retrieves an instance operation that has been performed on an instance.

sql_operations_list(connection, project, optional_params \\ [], opts \\ [])

Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

Functions

sql_operations_cancel(connection, project, operation, optional_params \\ [], opts \\ [])

@spec sql_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Cancels an instance operation that has been performed on an instance.

Parameters

connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
project (type: String.t) - Project ID of the project that contains the instance.
operation (type: String.t) - Instance operation ID.
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.SQLAdmin.V1beta4.Model.Empty{}} on success
{:error, info} on failure

sql_operations_get(connection, project, operation, optional_params \\ [], opts \\ [])

@spec sql_operations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an instance operation that has been performed on an instance.

Parameters

connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
project (type: String.t) - Project ID of the project that contains the instance.
operation (type: String.t) - Instance operation ID.
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.SQLAdmin.V1beta4.Model.Operation{}} on success
{:error, info} on failure

sql_operations_list(connection, project, optional_params \\ [], opts \\ [])

@spec sql_operations_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.OperationsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

Parameters

connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
project (type: String.t) - Project ID of the project that contains the instance.
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").
- :instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
- :maxResults (type: integer()) - Maximum number of operations per response.
- :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.OperationsListResponse{}} on success
{:error, info} on failure