Class: Google::Cloud::Iot::V1::ListDevicesRequest

Inherits:

Object

• Object
• Google::Cloud::Iot::V1::ListDevicesRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/iot/v1/device_manager.rb

Overview

Request for ListDevices.

Instance Attribute Summary

• #device_ids ⇒ ::Array<::String>

  A list of device string IDs.

• #device_num_ids ⇒ ::Array<::Integer>

  A list of device numeric IDs.

• #field_mask ⇒ ::Google::Protobuf::FieldMask

  The fields of the Device resource to be returned in the response.

• #gateway_list_options ⇒ ::Google::Cloud::Iot::V1::GatewayListOptions

  Options related to gateways.

• #page_size ⇒ ::Integer

  The maximum number of devices to return in the response.

• #page_token ⇒ ::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 ⇒ ::String

  Required.

Instance Attribute Details

#device_ids ⇒ ::Array<::String>

Returns 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

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#device_num_ids ⇒ ::Array<::Integer>

Returns 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.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.

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.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#gateway_list_options ⇒ ::Google::Cloud::Iot::V1::GatewayListOptions

Returns Options related to gateways.

Returns:

• (::Google::Cloud::Iot::V1::GatewayListOptions) —

  Options related to gateways.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/iot/v1/device_manager.rb', line 204

class ListDevicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end