Cloud IoT V1 API - Class Google::Cloud::Iot::V1::ListDevicesRequest (v0.6.0)

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

Request for ListDevices.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#device_ids

def device_ids() -> ::Array<::String>
Returns
  • (::Array<::String>) — A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

#device_ids=

def device_ids=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000
Returns
  • (::Array<::String>) — A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

#device_num_ids

def device_num_ids() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

#device_num_ids=

def device_num_ids=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
Returns
  • (::Array<::Integer>) — A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

#field_mask

def field_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.

#field_mask=

def field_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.
Returns
  • (::Google::Protobuf::FieldMask) — The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.

#gateway_list_options

def gateway_list_options() -> ::Google::Cloud::Iot::V1::GatewayListOptions
Returns

#gateway_list_options=

def gateway_list_options=(value) -> ::Google::Cloud::Iot::V1::GatewayListOptions
Parameter
Returns

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
Returns
  • (::Integer) — The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.
Returns
  • (::String) — The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.
Returns
  • (::String) — Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.