Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class ListClustersResponse.
Response for ListClusters.
Generated from protobuf message google.cloud.redis.cluster.v1.ListClustersResponse
Namespace
Google \ Cloud \ Redis \ Cluster \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ clusters |
array<Google\Cloud\Redis\Cluster\V1\Cluster>
A list of Redis clusters in the project in the specified location, or across all locations. If the |
↳ next_page_token |
string
Token to retrieve the next page of results, or empty if there are no more results in the list. |
↳ unreachable |
array
Locations that could not be reached. |
getClusters
A list of Redis clusters in the project in the specified location, or across all locations.
If the location_id in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
Redis entry is included in the response with the name field set to a
value of the form
projects/{project_id}/locations/{location_id}/clusters/- and the
status field set to ERROR and status_message field set to "location not
available for ListClusters".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setClusters
A list of Redis clusters in the project in the specified location, or across all locations.
If the location_id in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
Redis entry is included in the response with the name field set to a
value of the form
projects/{project_id}/locations/{location_id}/clusters/- and the
status field set to ERROR and status_message field set to "location not
available for ListClusters".
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Redis\Cluster\V1\Cluster>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextPageToken
Token to retrieve the next page of results, or empty if there are no more results in the list.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNextPageToken
Token to retrieve the next page of results, or empty if there are no more results in the list.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnreachable
Locations that could not be reached.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setUnreachable
Locations that could not be reached.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|