google_api_sql_admin

v0.0.1

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

API calls for all endpoints tagged Databases.

Link to this section Summary

Functions

sql_databases_delete(connection, project, instance, database, opts \\ [])

Deletes a database from a Cloud SQL instance

sql_databases_get(connection, project, instance, database, opts \\ [])

Retrieves a resource containing information about a database inside a Cloud SQL instance

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

Inserts a resource containing information about a database inside a Cloud SQL instance

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

Lists databases in the specified Cloud SQL instance

sql_databases_patch(connection, project, instance, database, opts \\ [])

Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics

sql_databases_update(connection, project, instance, database, opts \\ [])

Updates a resource containing information about a database inside a Cloud SQL instance

Link to this section Functions

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

Deletes a database from a Cloud SQL instance.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Database instance ID. This does not include the project ID.
  • database (String): Name of the database to be deleted in the instance.

  • 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_databases_get(connection, project, instance, database, opts \\ []) View Source 
sql_databases_get(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Database.t} |
  {:error, Tesla.Env.t}

Retrieves a resource containing information about a database inside a Cloud SQL instance.

Parameters

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

  • 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.Database{}} on success {:error, info} on failure

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

Inserts a resource containing information about a database inside a Cloud SQL instance.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Database 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 (Database):

Returns

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

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

Lists databases in the specified Cloud SQL instance.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project for which to list Cloud SQL instances.
  • 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.

Returns

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

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

Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Database instance ID. This does not include the project ID.
  • database (String): Name of the database to be updated in the instance.

  • 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 (Database):

Returns

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

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

Updates a resource containing information about a database inside a Cloud SQL instance.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Database instance ID. This does not include the project ID.
  • database (String): Name of the database to be updated in the instance.

  • 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 (Database):

Returns

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