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 messagegoogle.cloud.iot.v1.GatewayListOptions
Namespace
Google \ Cloud \ Iot \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ gateway_type
int
IfGATEWAYis specified, only gateways are returned. IfNON_GATEWAYis specified, only non-gateway devices are returned. IfGATEWAY_TYPE_UNSPECIFIEDis specified, all devices are returned.
↳ associations_gateway_id
string
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, if123is specified, only devices bound to the gateway withnum_id123 are returned.
↳ associations_device_id
string
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, if456is specified, returns only the gateways to which the device withnum_id456 is bound.
getGatewayType
IfGATEWAYis specified, only gateways are returned. IfNON_GATEWAYis specified, only non-gateway devices are returned. IfGATEWAY_TYPE_UNSPECIFIEDis specified, all devices are returned.
Returns
Type
Description
int
hasGatewayType
setGatewayType
IfGATEWAYis specified, only gateways are returned. IfNON_GATEWAYis specified, only non-gateway devices are returned. IfGATEWAY_TYPE_UNSPECIFIEDis 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, if123is specified, only devices bound to the
gateway withnum_id123 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, if123is specified, only devices bound to the
gateway withnum_id123 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, if456is specified, returns only the
gateways to which the device withnum_id456 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, if456is specified, returns only the
gateways to which the device withnum_id456 is bound.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud IoT Core V1 Client - Class GatewayListOptions (1.7.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.5 (latest)](/php/docs/reference/cloud-iot/latest/V1.GatewayListOptions)\n- [1.7.4](/php/docs/reference/cloud-iot/1.7.4/V1.GatewayListOptions)\n- [1.6.4](/php/docs/reference/cloud-iot/1.6.4/V1.GatewayListOptions)\n- [1.5.12](/php/docs/reference/cloud-iot/1.5.12/V1.GatewayListOptions) \nReference documentation and code samples for the Google Cloud IoT Core V1 Client class GatewayListOptions.\n\nOptions for limiting the list based on gateway type and associations.\n\nGenerated from protobuf message `google.cloud.iot.v1.GatewayListOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Iot \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGatewayType\n\nIf `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`\nis specified, only non-gateway devices are returned. If\n`GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.\n\n### hasGatewayType\n\n### setGatewayType\n\nIf `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`\nis specified, only non-gateway devices are returned. If\n`GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.\n\n### getAssociationsGatewayId\n\nIf set, only devices associated with the specified gateway are returned.\n\nThe gateway ID can be numeric (`num_id`) or the user-defined string\n(`id`). For example, if `123` is specified, only devices bound to the\ngateway with `num_id` 123 are returned.\n\n### hasAssociationsGatewayId\n\n### setAssociationsGatewayId\n\nIf set, only devices associated with the specified gateway are returned.\n\nThe gateway ID can be numeric (`num_id`) or the user-defined string\n(`id`). For example, if `123` is specified, only devices bound to the\ngateway with `num_id` 123 are returned.\n\n### getAssociationsDeviceId\n\nIf set, returns only the gateways with which the specified device is\nassociated. The device ID can be numeric (`num_id`) or the user-defined\nstring (`id`). For example, if `456` is specified, returns only the\ngateways to which the device with `num_id` 456 is bound.\n\n### hasAssociationsDeviceId\n\n### setAssociationsDeviceId\n\nIf set, returns only the gateways with which the specified device is\nassociated. The device ID can be numeric (`num_id`) or the user-defined\nstring (`id`). For example, if `456` is specified, returns only the\ngateways to which the device with `num_id` 456 is bound.\n\n### getFilter"]]
