google_api_sql_admin

v0.0.1

google_api_sql_admin v0.0.1 GoogleApi.SQLAdmin.V1beta4.Api.BackupRuns View Source

API calls for all endpoints tagged BackupRuns.

Link to this section Summary

Functions

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

Deletes the backup taken by a backup run

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

Retrieves a resource containing information about a backup run

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

Creates a new backup run on demand. This method is applicable only to Second Generation instances

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

Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time

Link to this section Functions

Link to this function sql_backup_runs_delete(connection, project, instance, id, opts \\ []) View Source 
sql_backup_runs_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t} |
  {:error, Tesla.Env.t}

Deletes the backup taken by a backup run.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.
  • id (String): The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function sql_backup_runs_get(connection, project, instance, id, opts \\ []) View Source 
sql_backup_runs_get(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.BackupRun.t} |
  {:error, Tesla.Env.t}

Retrieves a resource containing information about a backup run.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.
  • id (String): The ID of this Backup Run.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function sql_backup_runs_insert(connection, project, instance, opts \\ []) View Source 
sql_backup_runs_insert(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t} |
  {:error, Tesla.Env.t}

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): Project ID of the project that contains the instance.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (BackupRun):

Returns

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

Link to this function sql_backup_runs_list(connection, project, instance, opts \\ []) View Source 
sql_backup_runs_list(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.BackupRunsListResponse.t} |
  {:error, Tesla.Env.t}

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

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :max_results (Integer): Maximum number of backup runs per response.
    • :page_token (String): 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