google_api_sql_admin v0.6.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 (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String.t): Project ID of the project that contains the instance.
  • instance (String.t): Database instance ID. This does not include the project ID.
  • host (String.t): Host of the user in the instance.
  • name (String.t): Name of the user in the instance.
  • 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

Link to this function

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

Creates a new user in a Cloud SQL instance.

Parameters

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

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

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 (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String.t): Project ID of the project that contains the instance.
  • instance (String.t): Database instance ID. This does not include the project ID.
  • name (String.t): Name of the user in the instance.
  • 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.
    • :host (String.t): Host of the user in the instance.
    • :body (User):

Returns

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