google_api_sql_admin

v0.0.1

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

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

sql_users_delete(connection, project, instance, host, name, opts \\ [])

Deletes a user from a Cloud SQL instance

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

Creates a new user in a Cloud SQL instance

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

Lists users in the specified Cloud SQL instance

sql_users_update(connection, project, instance, host, name, opts \\ [])

Updates an existing user in a Cloud SQL instance

Link to this section Functions

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

Deletes a user 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.
  • host (String): Host of the user in the instance.
  • name (String): Name of the user 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_users_insert(connection, project, instance, opts \\ []) View Source 
sql_users_insert(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t} |
  {:error, Tesla.Env.t}

Creates a new user in 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 (User):

Returns

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

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

Lists users in the specified 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.

Returns

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

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

Updates an existing user in 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.
  • host (String): Host of the user in the instance.
  • name (String): Name of the user 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 (User):

Returns

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