google_api_sql_admin v0.6.0 GoogleApi.SQLAdmin.V1beta4.Api.BackupRuns View Source
API calls for all endpoints tagged BackupRuns
.
Link to this section Summary
Functions
Deletes the backup taken by a backup run.
Retrieves a resource containing information about a backup run.
Creates a new backup run on demand. This method is applicable only to Second Generation instances.
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
Link to this section Functions
sql_backup_runs_delete(connection, project, instance, id, optional_params \\ [], opts \\ []) View Source
Deletes the backup taken by a backup run.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Cloud SQL instance ID. This does not include the project ID.
- id (String.t): The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure
sql_backup_runs_get(connection, project, instance, id, optional_params \\ [], opts \\ []) View Source
Retrieves a resource containing information about a backup run.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Cloud SQL instance ID. This does not include the project ID.
- id (String.t): The ID of this Backup Run.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.BackupRun{}} on success {:error, info} on failure
sql_backup_runs_insert(connection, project, instance, optional_params \\ [], opts \\ []) View Source
Creates a new backup run on demand. This method is applicable only to Second Generation instances.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Cloud SQL instance ID. This does not include the project ID.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (BackupRun):
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure
sql_backup_runs_list(connection, project, instance, optional_params \\ [], opts \\ []) View Source
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Cloud SQL instance ID. This does not include the project ID.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :maxResults (integer()): Maximum number of backup runs per response.
- :pageToken (String.t): A previously-returned page token representing part of the larger set of results to view.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.BackupRunsListResponse{}} on success {:error, info} on failure