Google Cloud Redis V1 Client - Class ListInstancesResponse (2.1.6)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Cloud Redis V1 Client class ListInstancesResponse.
Response for ListInstances.
Generated from protobuf message google.cloud.redis.v1.ListInstancesResponse
Namespace
Google \ Cloud \ Redis \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instances |
array<Instance>
A list of Redis instances 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. |
getInstances
A list of Redis instances 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}/instances/- and the
status field set to ERROR and status_message field set to "location not
available for ListInstances".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInstances
A list of Redis instances 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}/instances/- and the
status field set to ERROR and status_message field set to "location not
available for ListInstances".
| Parameter | |
|---|---|
| Name | Description |
var |
array<Instance>
|
| 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 |
|