GoogleApi.SQLAdmin.V1.Api.BackupRuns (google_api_sql_admin v0.71.0)

View Source

API calls for all endpoints tagged BackupRuns.

Summary

Functions

sql_backup_runs_delete(connection, project, instance, id, optional_params \\ [], opts \\ [])

Deletes the backup taken by a backup run.

sql_backup_runs_get(connection, project, instance, id, optional_params \\ [], opts \\ [])

Retrieves a resource containing information about a backup run.

sql_backup_runs_insert(connection, project, instance, optional_params \\ [], opts \\ [])

Creates a new backup run on demand.

sql_backup_runs_list(connection, project, instance, optional_params \\ [], opts \\ [])

Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.

Functions

sql_backup_runs_delete(connection, project, instance, id, optional_params \\ [], opts \\ [])

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

Deletes the backup taken by a backup run.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • id (type: String.t) - The ID of the backup run to delete. To find a backup run ID, use the list method.
  • 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.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_backup_runs_get(connection, project, instance, id, optional_params \\ [], opts \\ [])

@spec sql_backup_runs_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.BackupRun.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a resource containing information about a backup run.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • id (type: String.t) - The ID of this backup run.
  • 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.V1.Model.BackupRun{}} on success
  • {:error, info} on failure

sql_backup_runs_insert(connection, project, instance, optional_params \\ [], opts \\ [])

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

Creates a new backup run on demand.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project 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").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.BackupRun.t) -
  • opts (type: keyword()) - Call options

Returns

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

sql_backup_runs_list(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_backup_runs_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.BackupRunsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID, or "-" for all instances. This does not include the project 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").
    • :maxResults (type: integer()) - Maximum number of backup runs 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.V1.Model.BackupRunsListResponse{}} on success
  • {:error, info} on failure