Reference documentation and code samples for the Compute V1 Client class InstanceList.
Contains a list of instances.
Generated from protobuf message google.cloud.compute.v1.InstanceList
Namespace
Google \ Cloud \ Compute \ V1Methods
__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\Cloud\Compute\V1\Instance>
A list of Instance resources. |
↳ kind |
string
[Output Only] Type of resource. Always compute#instanceList for 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. |
↳ 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
A list of Instance resources.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setItems
A list of Instance resources.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\Instance>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#instanceList for 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
[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 | |
|---|---|
| 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 | |
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 | |