Reference documentation and code samples for the Google Cloud IoT Core V1 Client class GatewayListOptions.
Options for limiting the list based on gateway type and associations.
Generated from protobuf message google.cloud.iot.v1.GatewayListOptions
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ gateway_type |
int
If |
↳ associations_gateway_id |
string
If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric ( |
↳ associations_device_id |
string
If set, returns only the gateways with which the specified device is associated. The device ID can be numeric ( |
getGatewayType
If GATEWAY is specified, only gateways are returned. If NON_GATEWAY
is specified, only non-gateway devices are returned. If
GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned.
| Returns | |
|---|---|
| Type | Description |
int | |
hasGatewayType
setGatewayType
If GATEWAY is specified, only gateways are returned. If NON_GATEWAY
is specified, only non-gateway devices are returned. If
GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssociationsGatewayId
If set, only devices associated with the specified gateway are returned.
The gateway ID can be numeric (num_id) or the user-defined string
(id). For example, if 123 is specified, only devices bound to the
gateway with num_id 123 are returned.
| Returns | |
|---|---|
| Type | Description |
string | |
hasAssociationsGatewayId
setAssociationsGatewayId
If set, only devices associated with the specified gateway are returned.
The gateway ID can be numeric (num_id) or the user-defined string
(id). For example, if 123 is specified, only devices bound to the
gateway with num_id 123 are returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssociationsDeviceId
If set, returns only the gateways with which the specified device is
associated. The device ID can be numeric (num_id) or the user-defined
string (id). For example, if 456 is specified, returns only the
gateways to which the device with num_id 456 is bound.
| Returns | |
|---|---|
| Type | Description |
string | |
hasAssociationsDeviceId
setAssociationsDeviceId
If set, returns only the gateways with which the specified device is
associated. The device ID can be numeric (num_id) or the user-defined
string (id). For example, if 456 is specified, returns only the
gateways to which the device with num_id 456 is bound.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
| Returns | |
|---|---|
| Type | Description |
string | |