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

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

Request message for GetAuthToken.

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

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

getName

Required. The name of auth token for a token based auth enabled cluster.

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

Returns
Type Description
string

setName

Required. The name of auth token for a token based auth enabled cluster.

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} Please see CloudRedisClusterClient::authTokenName() for help formatting this field.
Returns
Type Description
GetAuthTokenRequest