Google Cloud Redis Cluster V1 Client - Class AuthToken (0.11.0)

Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class AuthToken.

Auth token for the cluster.

Generated from protobuf message google.cloud.redis.cluster.v1.AuthToken

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
`↳ token`	`string` Output only. The service generated authentication token used to connect to the Redis cluster.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Create time of the auth token.
`↳ state`	`int` Output only. State of the auth token.

getName

Identifier. Name of the auth token.

Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

Returns
Type	Description
`string`

setName

Identifier. Name of the auth token.

Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getToken

Output only. The service generated authentication token used to connect to the Redis cluster.

Returns
Type	Description
`string`

setToken

Output only. The service generated authentication token used to connect to the Redis cluster.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Create time of the auth token.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime