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

API calls for all endpoints tagged Users.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Deletes a user from a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Database instance ID. This does not include the project ID.
  • host (type: String.t) - Host of the user in the instance.
  • name (type: String.t) - Name of the user in the instance.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_users_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Creates a new user in a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Database instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.User.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Lists users in the specified Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Database instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.UsersListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Updates an existing user in a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Database instance ID. This does not include the project ID.
  • name (type: String.t) - Name of the user in the instance.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :host (type: String.t) - Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional.
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.User.t) -
  • opts (type: keyword()) - Call options

Returns

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