Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_SQLAdmin_Users_Resource Class Reference

The "users" collection of methods. More...

Inheritance diagram for Google_Service_SQLAdmin_Users_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $instance, $host, $name, $optParams=array())
 Deletes a user from a Cloud SQL instance.
 
 insert ($project, $instance, Google_Service_SQLAdmin_User $postBody, $optParams=array())
 Creates a new user in a Cloud SQL instance.
 
 listUsers ($project, $instance, $optParams=array())
 Lists users in the specified Cloud SQL instance.
 
 update ($project, $instance, $host, $name, Google_Service_SQLAdmin_User $postBody, $optParams=array())
 Updates an existing user in a Cloud SQL instance.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "users" collection of methods.

Typical usage is: $sqladminService = new Google_Service_SQLAdmin(...); $users = $sqladminService->users;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_SQLAdmin_Users_Resource::delete ( $project,
$instance,
$host,
$name,
$optParams = array() )

Deletes a user from a Cloud SQL instance.

(users.delete)

Parameters
string$projectProject ID of the project that contains the instance.
string$instanceDatabase instance ID. This does not include the project ID.
string$hostHost of the user in the instance.
string$nameName of the user in the instance.
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_Operation

◆ insert()

Google_Service_SQLAdmin_Users_Resource::insert ( $project,
$instance,
Google_Service_SQLAdmin_User $postBody,
$optParams = array() )

Creates a new user in a Cloud SQL instance.

(users.insert)

Parameters
string$projectProject ID of the project that contains the instance.
string$instanceDatabase instance ID. This does not include the project ID.
Google_User$postBody
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_Operation

◆ listUsers()

Google_Service_SQLAdmin_Users_Resource::listUsers ( $project,
$instance,
$optParams = array() )

Lists users in the specified Cloud SQL instance.

(users.listUsers)

Parameters
string$projectProject ID of the project that contains the instance.
string$instanceDatabase instance ID. This does not include the project ID.
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_UsersListResponse

◆ update()

Google_Service_SQLAdmin_Users_Resource::update ( $project,
$instance,
$host,
$name,
Google_Service_SQLAdmin_User $postBody,
$optParams = array() )

Updates an existing user in a Cloud SQL instance.

(users.update)

Parameters
string$projectProject ID of the project that contains the instance.
string$instanceDatabase instance ID. This does not include the project ID.
string$hostHost of the user in the instance.
string$nameName of the user in the instance.
Google_User$postBody
array$optParamsOptional parameters.
Return values
Google_Service_SQLAdmin_Operation

The documentation for this class was generated from the following file: