Reference documentation and code samples for the Compute V1 Client class RegionInstanceGroupsListInstancesRequest.
Generated from protobuf message google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance_state |
string
Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. Check the InstanceState enum for the list of possible values. |
↳ port_name |
string
Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. |
getInstanceState
Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
Check the InstanceState enum for the list of possible values.
Generated from protobuf field optional string instance_state = 92223591;
| Returns | |
|---|---|
| Type | Description |
string | |
hasInstanceState
clearInstanceState
setInstanceState
Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
Check the InstanceState enum for the list of possible values.
Generated from protobuf field optional string instance_state = 92223591;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPortName
Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
Generated from protobuf field optional string port_name = 41534345;
| Returns | |
|---|---|
| Type | Description |
string | |
hasPortName
clearPortName
setPortName
Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
Generated from protobuf field optional string port_name = 41534345;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |