Struct gapi_grpc::google::cloud::iot::v1::ListDevicesRequest

pub struct ListDevicesRequest {
    pub parent: String,
    pub device_num_ids: Vec<u64>,
    pub device_ids: Vec<String>,
    pub field_mask: Option<FieldMask>,
    pub gateway_list_options: Option<GatewayListOptions>,
    pub page_size: i32,
    pub page_token: String,
}

Request for ListDevices.

Fields

parent: String

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.

device_num_ids: Vec<u64>

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

device_ids: Vec<String>

A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

field_mask: Option<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: Option<GatewayListOptions>

Options related to gateways.

page_size: i32

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

Trait Implementations

impl Clone for ListDevicesRequest

fn clone(&self) -> ListDevicesRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListDevicesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListDevicesRequest

fn default() -> ListDevicesRequest

Returns the “default value” for a type.

impl Message for ListDevicesRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ListDevicesRequest> for ListDevicesRequest

fn eq(&self, other: &ListDevicesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListDevicesRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for ListDevicesRequest