Compute V1 Client - Class InstanceAggregatedList (1.9.1)

Reference documentation and code samples for the Compute V1 Client class InstanceAggregatedList.

Generated from protobuf message google.cloud.compute.v1.InstanceAggregatedList

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

[Output Only] Unique identifier for the resource; defined by the server.

↳ items array|Google\Protobuf\Internal\MapField

An object that contains a list of instances scoped by zone.

↳ kind string

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

↳ next_page_token string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

↳ self_link string

[Output Only] Server-defined URL for this resource.

↳ unreachables array

[Output Only] Unreachable resources.

↳ warning Google\Cloud\Compute\V1\Warning

[Output Only] Informational warning message.

getId

[Output Only] Unique identifier for the resource; defined by the server.

Returns
TypeDescription
string

hasId

clearId

setId

[Output Only] Unique identifier for the resource; defined by the server.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getItems

An object that contains a list of instances scoped by zone.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setItems

An object that contains a list of instances scoped by zone.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getKind

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNextPageToken

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

Returns
TypeDescription
string

hasNextPageToken

clearNextPageToken

setNextPageToken

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

[Output Only] Server-defined URL for this resource.

Returns
TypeDescription
string

[Output Only] Server-defined URL for this resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUnreachables

[Output Only] Unreachable resources.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUnreachables

[Output Only] Unreachable resources.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getWarning

[Output Only] Informational warning message.

Returns
TypeDescription
Google\Cloud\Compute\V1\Warning|null

hasWarning

clearWarning

setWarning

[Output Only] Informational warning message.

Parameter
NameDescription
var Google\Cloud\Compute\V1\Warning
Returns
TypeDescription
$this