public sealed class GatewayListOptions : IMessage<GatewayListOptions>, IEquatable<GatewayListOptions>, IDeepCloneable<GatewayListOptions>, IBufferMessage, IMessage
Options for limiting the list based on gateway type and associations.
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.
Property Value
Type
Description
System.String
AssociationsGatewayId
public string AssociationsGatewayId { get; set; }
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.
Property Value
Type
Description
System.String
FilterCase
public GatewayListOptions.FilterOneofCase FilterCase { get; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGatewayListOptions\u003c/code\u003e class provides options for filtering lists of gateways based on type and associations, inheriting from \u003ccode\u003eObject\u003c/code\u003e and implementing multiple interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis class offers two constructors: a default constructor \u003ccode\u003eGatewayListOptions()\u003c/code\u003e and a copy constructor \u003ccode\u003eGatewayListOptions(GatewayListOptions other)\u003c/code\u003e, which enables creating a new instance based on an existing one.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGatewayListOptions\u003c/code\u003e includes properties like \u003ccode\u003eAssociationsDeviceId\u003c/code\u003e and \u003ccode\u003eAssociationsGatewayId\u003c/code\u003e which are used to specify device or gateway IDs for filtering related gateways or associated devices, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGatewayType\u003c/code\u003e property allows filtering the list to only include gateways, non-gateway devices, or all devices if \u003ccode\u003eGATEWAY_TYPE_UNSPECIFIED\u003c/code\u003e is selected.\u003c/p\u003e\n"],["\u003cp\u003eThere are multiple versions of this documentation available, with version \u003ccode\u003e2.2.0\u003c/code\u003e being the latest, and version \u003ccode\u003e2.0.0\u003c/code\u003e is the current page documentation.\u003c/p\u003e\n"]]],[],null,[]]
