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

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

Request message for AddAuthToken.

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

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ token_auth_user string

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
↳ auth_token AuthToken

Required. The auth token to add.

getTokenAuthUser

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

Returns
Type Description
string

setTokenAuthUser

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}

Parameter
Name Description
var string
Returns
Type Description
$this

getAuthToken

Required. The auth token to add.

Returns
Type Description
AuthToken|null

hasAuthToken

clearAuthToken

setAuthToken

Required. The auth token to add.

Parameter
Name Description
var AuthToken
Returns
Type Description
$this

static::build

Parameters
Name Description
tokenAuthUser string

Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} Please see CloudRedisClusterClient::tokenAuthUserName() for help formatting this field.
authToken AuthToken

Required. The auth token to add.
Returns
Type Description
AddAuthTokenRequest