Cloud Bigtable V2 Client - Class ListInstancesResponse (1.31.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class ListInstancesResponse.

Response message for BigtableInstanceAdmin.ListInstances.

Generated from protobuf message google.bigtable.admin.v2.ListInstancesResponse

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instances array<Google\Cloud\Bigtable\Admin\V2\Instance>

The list of requested instances.

↳ failed_locations array

Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from instances, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

↳ next_page_token string

DEPRECATED: This field is unused and ignored.

getInstances

The list of requested instances.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInstances

The list of requested instances.

Parameter
Name Description
var array<Google\Cloud\Bigtable\Admin\V2\Instance>
Returns
Type Description
$this

getFailedLocations

Locations from which Instance information could not be retrieved, due to an outage or some other transient condition.

Instances whose Clusters are all in one of the failed locations may be missing from instances, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFailedLocations

Locations from which Instance information could not be retrieved, due to an outage or some other transient condition.

Instances whose Clusters are all in one of the failed locations may be missing from instances, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

Parameter
Name Description
var string[]
Returns
Type Description
$this

getNextPageToken

DEPRECATED: This field is unused and ignored.

Returns
Type Description
string

setNextPageToken

DEPRECATED: This field is unused and ignored.

Parameter
Name Description
var string
Returns
Type Description
$this