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

ProjectsLocationsClustersUsers

class ProjectsLocationsClustersUsers extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $alloydbService = new Google\Service\CloudAlloyDBAdmin(...);
 $users = $alloydbService->projects_locations_clusters_users;

Methods

User
create(string $parent, User $postBody, array $optParams = [])

Creates a new User in a given project, location, and cluster. (users.create)

AlloydbEmpty
delete(string $name, array $optParams = [])

Deletes a single User. (users.delete)

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

Gets details of a single User. (users.get)

ListUsersResponse
listProjectsLocationsClustersUsers(string $parent, array $optParams = [])

Lists Users in a given project and location.

User
patch(string $name, User $postBody, array $optParams = [])

Updates the parameters of a single User. (users.patch)

Details

at line 58
User create(string $parent, User $postBody, array $optParams = [])

Creates a new User in a given project, location, and cluster. (users.create)

Parameters

string $parent

Required. Value for parent.
User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

at line 87
AlloydbEmpty delete(string $name, array $optParams = [])

Deletes a single User. (users.delete)

Parameters

string $name

Required. The name of the resource. For the required format, see the comment on the User.name field.
array $optParams

Optional parameters.

Return Value

AlloydbEmpty

Exceptions

Exception

at line 102
User get(string $name, array $optParams = [])

Gets details of a single User. (users.get)

Parameters

string $name

Required. The name of the resource. For the required format, see the comment on the User.name field.
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

at line 125
ListUsersResponse listProjectsLocationsClustersUsers(string $parent, array $optParams = [])

Lists Users in a given project and location.

(users.listProjectsLocationsClustersUsers)

Parameters

string $parent

Required. Parent value for ListUsersRequest
array $optParams

Optional parameters.

Return Value

ListUsersResponse

Exceptions

Exception

at line 162
User patch(string $name, User $postBody, array $optParams = [])

Updates the parameters of a single User. (users.patch)

Parameters

string $name

Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception