Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class CreateUserRequest.
Message for creating a User
Generated from protobuf message google.cloud.alloydb.v1.CreateUserRequest
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Value for parent. |
↳ user_id |
string
Required. ID of the requesting object. |
↳ user |
Google\Cloud\AlloyDb\V1\User
Required. The resource being created |
↳ request_id |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validate_only |
bool
Optional. If set, the backend validates the request, but doesn't actually execute it. |
getParent
Required. Value for parent.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Value for parent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserId
Required. ID of the requesting object.
| Returns | |
|---|---|
| Type | Description |
string | |
setUserId
Required. ID of the requesting object.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUser
Required. The resource being created
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AlloyDb\V1\User|null | |
hasUser
clearUser
setUser
Required. The resource being created
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AlloyDb\V1\User
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string | |
setRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
Optional. If set, the backend validates the request, but doesn't actually execute it.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
Optional. If set, the backend validates the request, but doesn't actually execute it.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. Value for parent. Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field. |
user |
Google\Cloud\AlloyDb\V1\User
Required. The resource being created |
userId |
string
Required. ID of the requesting object. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AlloyDb\V1\CreateUserRequest | |