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

API calls for all endpoints tagged Backups.

Summary

Functions

sql__backups__create_backup(connection, parent, optional_params \\ [], opts \\ [])

Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.

sql__backups__delete_backup(connection, name, optional_params \\ [], opts \\ [])

Deletes the backup.

sql__backups__get_backup(connection, name, optional_params \\ [], opts \\ [])

Retrieves a resource containing information about a backup.

sql__backups__list_backups(connection, parent, optional_params \\ [], opts \\ [])

Lists all backups associated with the project.

sql__backups__update_backup(connection, name, optional_params \\ [], opts \\ [])

Updates the retention period and description of the backup. You can use this API to update final backups only.

Functions

sqlbackupscreate_backup(connection, parent, optional_params \\ [], opts \\ [])

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

Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.

Parameters

connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource where this backup is created. Format: projects/{project}
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.Backup.t) -
opts (type: keyword()) - Call options

Returns

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

sqlbackupsdelete_backup(connection, name, optional_params \\ [], opts \\ [])

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

Deletes the backup.

Parameters

connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}
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

sqlbackupsget_backup(connection, name, optional_params \\ [], opts \\ [])

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

Retrieves a resource containing information about a backup.

Parameters

connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}
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.Backup{}} on success
{:error, info} on failure

sqlbackupslist_backups(connection, parent, optional_params \\ [], opts \\ [])

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

Lists all backups associated with the project.

Parameters

connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent that owns this collection of backups. Format: projects/{project}
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) - Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.
- :pageSize (type: integer()) - The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.
- :pageToken (type: String.t) - A page token, received from a previous ListBackups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.
opts (type: keyword()) - Call options

Returns

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

sqlbackupsupdate_backup(connection, name, optional_params \\ [], opts \\ [])

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

Updates the retention period and description of the backup. You can use this API to update final backups only.

Parameters

connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
name (type: String.t) - Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.
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").
- :updateMask (type: String.t) - The list of fields that you can update. You can update only the description and retention period of the final backup.
- :body (type: GoogleApi.SQLAdmin.V1.Model.Backup.t) -
opts (type: keyword()) - Call options

Returns

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