Cloud Firestore V1 Client - Class UserCreds (1.53.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class UserCreds.

A Cloud Firestore User Creds.

Generated from protobuf message google.firestore.admin.v1.UserCreds

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the UserCreds. Format: projects/{project}/databases/{database}/userCreds/{user_creds}

↳ create_time
Google\Protobuf\Timestamp

Output only. The time the user creds were created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time the user creds were last updated.

↳ state
int

Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

↳ secure_password
string

Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.

↳ resource_identity
UserCreds\ResourceIdentity

Resource Identity descriptor.

getName

Identifier. The resource name of the UserCreds.

Format: projects/{project}/databases/{database}/userCreds/{user_creds}

Returns
Type
Description
string

setName

Identifier. The resource name of the UserCreds.

Format: projects/{project}/databases/{database}/userCreds/{user_creds}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. The time the user creds were created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the user creds were created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time the user creds were last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the user creds were last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

Returns
Type
Description
int

setState

Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getSecurePassword

Output only. The plaintext server-generated password for the user creds.

Only populated in responses for CreateUserCreds and ResetUserPassword.

Returns
Type
Description
string

setSecurePassword

Output only. The plaintext server-generated password for the user creds.

Only populated in responses for CreateUserCreds and ResetUserPassword.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getResourceIdentity

Resource Identity descriptor.

Returns
Type
Description

hasResourceIdentity

setResourceIdentity

Resource Identity descriptor.

Parameter
Name
Description
Returns
Type
Description
$this

getUserCredsIdentity

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: