Cloud IoT v1 API - Class GatewayListOptions (2.2.0) 

public sealed class GatewayListOptions : IMessage<GatewayListOptions>, IEquatable<GatewayListOptions>, IDeepCloneable<GatewayListOptions>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud IoT v1 API class GatewayListOptions.

Options for limiting the list based on gateway type and associations.

Inheritance

object > GatewayListOptions

Namespace

Google.Cloud.Iot.V1

Assembly

Google.Cloud.Iot.V1.dll

Constructors

GatewayListOptions()

public GatewayListOptions()

GatewayListOptions(GatewayListOptions)

public GatewayListOptions(GatewayListOptions other)
Parameter
Name Description
other GatewayListOptions

Properties

AssociationsDeviceId

public string AssociationsDeviceId { get; set; }

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
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
string

FilterCase

public GatewayListOptions.FilterOneofCase FilterCase { get; }
Property Value
Type Description
GatewayListOptionsFilterOneofCase

GatewayType

public GatewayType GatewayType { get; set; }

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.

Property Value
Type Description
GatewayType

HasAssociationsDeviceId

public bool HasAssociationsDeviceId { get; }

Gets whether the "associations_device_id" field is set

Property Value
Type Description
bool

HasAssociationsGatewayId

public bool HasAssociationsGatewayId { get; }

Gets whether the "associations_gateway_id" field is set

Property Value
Type Description
bool

HasGatewayType

public bool HasGatewayType { get; }

Gets whether the "gateway_type" field is set

Property Value
Type Description
bool