Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class ListTokenAuthUsersRequest.
Request message for ListTokenAuthUsers.
Generated from protobuf message google.cloud.redis.cluster.v1.ListTokenAuthUsersRequest
Namespace
Google \ Cloud \ Redis \ Cluster \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster} |
↳ page_size |
int
Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. The |
↳ filter |
string
Optional. Expression for filtering results. |
↳ order_by |
string
Optional. Sort results by a defined order. |
getParent
Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
The maximum value is 1000; values above 1000 will be coerced to 1000.
next_page_token
to determine if there are more clusters left to be queried.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
The maximum value is 1000; values above 1000 will be coerced to 1000.
next_page_token
to determine if there are more clusters left to be queried.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The next_page_token value returned from a previous
[ListTokenAuthUsers] request, if any.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The next_page_token value returned from a previous
[ListTokenAuthUsers] request, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Expression for filtering results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Expression for filtering results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Sort results by a defined order.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Sort results by a defined order.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster} Please see CloudRedisClusterClient::clusterName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListTokenAuthUsersRequest |
|