Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class User.
Message describing User object.
Generated from protobuf message google.cloud.alloydb.v1.User
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
↳ password |
string
Input only. Password for the user. |
↳ database_roles |
array
Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
↳ user_type |
int
Optional. Type of this user. |
↳ keep_extra_roles |
bool
Input only. If the user already exists and it has additional roles, keep them granted. |
getName
Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPassword
Input only. Password for the user.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPassword
Input only. Password for the user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseRoles
Optional. List of database roles this user has.
The database role strings are subject to the PostgreSQL naming conventions.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDatabaseRoles
Optional. List of database roles this user has.
The database role strings are subject to the PostgreSQL naming conventions.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserType
Optional. Type of this user.
| Returns | |
|---|---|
| Type | Description |
int |
|
setUserType
Optional. Type of this user.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeepExtraRoles
Input only. If the user already exists and it has additional roles, keep them granted.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setKeepExtraRoles
Input only. If the user already exists and it has additional roles, keep them granted.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|