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
Name	Description
`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
Type	Description
`string`

hasId

clearId

setId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getItems

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setItems

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getKind

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

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`string`

hasNextPageToken

clearNextPageToken

setNextPageToken

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

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

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUnreachables

[Output Only] Unreachable resources.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setUnreachables

[Output Only] Unreachable resources.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getWarning

[Output Only] Informational warning message.

Returns
Type	Description
`Google\Cloud\Compute\V1\Warning\|null`

hasWarning

clearWarning

setWarning

[Output Only] Informational warning message.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\Warning`

Returns
Type	Description
`$this`