1. class
  2. Google
  3. \
  4. Service
  5. \
  6. SQLAdmin
  7. \
  8. Resource
  9. \
  10. Users

Users

class Users extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $sqladminService = new Google\Service\SQLAdmin(...);
 $users = $sqladminService->users;

Methods

Operation
delete(string $project, string $instance, array $optParams = [])

Deletes a user from a Cloud SQL instance. (users.delete)

User
get(string $project, string $instance, string $name, array $optParams = [])

Retrieves a resource containing information about a user. (users.get)

Operation
insert(string $project, string $instance, User $postBody, array $optParams = [])

Creates a new user in a Cloud SQL instance. (users.insert)

UsersListResponse
listUsers(string $project, string $instance, array $optParams = [])

Lists users in the specified Cloud SQL instance. (users.listUsers)

Operation
update(string $project, string $instance, User $postBody, array $optParams = [])

Updates an existing user in a Cloud SQL instance. (users.update)

Details

at line 47
Operation delete(string $project, string $instance, array $optParams = [])

Deletes a user from a Cloud SQL instance. (users.delete)

Parameters

string $project

Project ID of the project that contains the instance.
string $instance

Database instance ID. This does not include the project ID.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 66
User get(string $project, string $instance, string $name, array $optParams = [])

Retrieves a resource containing information about a user. (users.get)

Parameters

string $project

Project ID of the project that contains the instance.
string $instance

Database instance ID. This does not include the project ID.
string $name

User of the instance.
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

at line 83
Operation insert(string $project, string $instance, User $postBody, array $optParams = [])

Creates a new user in a Cloud SQL instance. (users.insert)

Parameters

string $project

Project ID of the project that contains the instance.
string $instance

Database instance ID. This does not include the project ID.
User $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 99
UsersListResponse listUsers(string $project, string $instance, array $optParams = [])

Lists users in the specified Cloud SQL instance. (users.listUsers)

Parameters

string $project

Project ID of the project that contains the instance.
string $instance

Database instance ID. This does not include the project ID.
array $optParams

Optional parameters.

Return Value

UsersListResponse

Exceptions

Exception

at line 119
Operation update(string $project, string $instance, User $postBody, array $optParams = [])

Updates an existing user in a Cloud SQL instance. (users.update)

Parameters

string $project

Project ID of the project that contains the instance.
string $instance

Database instance ID. This does not include the project ID.
User $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception