Reference documentation and code samples for the Cloud Firestore V1 Client class CreateUserCredsRequest.
The request for FirestoreAdmin.CreateUserCreds.
Generated from protobuf message google.firestore.admin.v1.CreateUserCredsRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. A parent name of the form |
↳ user_creds |
UserCreds
Required. The user creds to create. |
↳ user_creds_id |
string
Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. |
getParent
Required. A parent name of the form
projects/{project_id}/databases/{database_id}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. A parent name of the form
projects/{project_id}/databases/{database_id}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUserCreds
Required. The user creds to create.
Returns | |
---|---|
Type | Description |
UserCreds|null |
hasUserCreds
clearUserCreds
setUserCreds
Required. The user creds to create.
Parameter | |
---|---|
Name | Description |
var |
UserCreds
|
Returns | |
---|---|
Type | Description |
$this |
getUserCredsId
Required. The ID to use for the user creds, which will become the final component of the user creds's resource name.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
Returns | |
---|---|
Type | Description |
string |
setUserCredsId
Required. The ID to use for the user creds, which will become the final component of the user creds's resource name.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
userCreds |
UserCreds
Required. The user creds to create. |
userCredsId |
string
Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. |
Returns | |
---|---|
Type | Description |
CreateUserCredsRequest |