Compute V1 Client - Class InstanceList (1.5.0)

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

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\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.

Generated from protobuf field optional string id = 3355;

Returns
TypeDescription
string

hasId

clearId

setId

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

Generated from protobuf field optional string id = 3355;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getItems

A list of Instance resources.

Generated from protobuf field repeated .google.cloud.compute.v1.Instance items = 100526016;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setItems

A list of Instance resources.

Generated from protobuf field repeated .google.cloud.compute.v1.Instance items = 100526016;

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\Instance>
Returns
TypeDescription
$this

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

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.

Generated from protobuf field optional string next_page_token = 79797525;

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.

Generated from protobuf field optional string next_page_token = 79797525;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWarning

[Output Only] Informational warning message.

Generated from protobuf field optional .google.cloud.compute.v1.Warning warning = 50704284;

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

hasWarning

clearWarning

setWarning

[Output Only] Informational warning message.

Generated from protobuf field optional .google.cloud.compute.v1.Warning warning = 50704284;

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