Google Cloud Sql Admin V1 Client - Class SqlUsersUpdateRequest (1.9.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlUsersUpdateRequest.

Generated from protobuf message google.cloud.sql.v1.SqlUsersUpdateRequest

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ host
string

Optional. Host of the user in the instance.

↳ instance
string

Database instance ID. This does not include the project ID.

↳ name
string

Name of the user in the instance.

↳ project
string

Project ID of the project that contains the instance.

↳ database_roles
string[]

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

↳ revoke_existing_roles
bool

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

↳ body

getHost

Optional. Host of the user in the instance.

Returns
Type
Description
string

setHost

Optional. Host of the user in the instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInstance

Database instance ID. This does not include the project ID.

Returns
Type
Description
string

setInstance

Database instance ID. This does not include the project ID.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getName

Name of the user in the instance.

Returns
Type
Description
string

setName

Name of the user in the instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getProject

Project ID of the project that contains the instance.

Returns
Type
Description
string

setProject

Project ID of the project that contains the instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatabaseRoles

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

Returns
Type
Description

setDatabaseRoles

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getRevokeExistingRoles

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

Returns
Type
Description
bool

hasRevokeExistingRoles

clearRevokeExistingRoles

setRevokeExistingRoles

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getBody

Generated from protobuf field .google.cloud.sql.v1.User body = 100;

Returns
Type
Description
User |null

hasBody

clearBody

setBody

Generated from protobuf field .google.cloud.sql.v1.User body = 100;

Parameter
Name
Description
var
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: