Cloud IoT V1 API - Class Google::Cloud::Iot::V1::GatewayListOptions (v0.9.2)

Reference documentation and code samples for the Cloud IoT V1 API class Google::Cloud::Iot::V1::GatewayListOptions.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#associations_device_id

def associations_device_id() -> ::String
Returns
  • (::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, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.

#associations_device_id=

def associations_device_id=(value) -> ::String
Parameter
  • value (::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, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.
Returns
  • (::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, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.

#associations_gateway_id

def associations_gateway_id() -> ::String
Returns
  • (::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, if 123 is specified, only devices bound to the gateway with num_id 123 are returned.

#associations_gateway_id=

def associations_gateway_id=(value) -> ::String
Parameter
  • value (::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, if 123 is specified, only devices bound to the gateway with num_id 123 are returned.
Returns
  • (::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, if 123 is specified, only devices bound to the gateway with num_id 123 are returned.

#gateway_type

def gateway_type() -> ::Google::Cloud::Iot::V1::GatewayType
Returns
  • (::Google::Cloud::Iot::V1::GatewayType) — 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.

#gateway_type=

def gateway_type=(value) -> ::Google::Cloud::Iot::V1::GatewayType
Parameter
  • value (::Google::Cloud::Iot::V1::GatewayType) — 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
  • (::Google::Cloud::Iot::V1::GatewayType) — 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.