Cloud Firestore V1 Client - Class CreateUserCredsRequest (1.54.2)

Version latest

• 1.54.2 (latest)
• 1.54.1
• 1.53.1
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.1
• 1.47.3
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. A parent name of the form projects/{project_id}/databases/{database_id}
↳ 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 projects/{project_id}/databases/{database_id} Please see FirestoreAdminClient::databaseName() for help formatting this field.
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