Cloud IoT v1 API - Class ListDevicesRequest (2.2.0) 

public sealed class ListDevicesRequest : IMessage<ListDevicesRequest>, IEquatable<ListDevicesRequest>, IDeepCloneable<ListDevicesRequest>, IBufferMessage, IMessage, IPageRequest

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

Request for ListDevices.

Inheritance

object > ListDevicesRequest

Namespace

Google.Cloud.Iot.V1

Assembly

Google.Cloud.Iot.V1.dll

Constructors

ListDevicesRequest()

public ListDevicesRequest()

ListDevicesRequest(ListDevicesRequest)

public ListDevicesRequest(ListDevicesRequest other)
Parameter
Name Description
other ListDevicesRequest

Properties

DeviceIds

public RepeatedField<string> DeviceIds { get; }

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

Property Value
Type Description
RepeatedFieldstring

DeviceNumIds

public RepeatedField<ulong> DeviceNumIds { get; }

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

Property Value
Type Description
RepeatedFieldulong

FieldMask

public FieldMask FieldMask { get; set; }

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.

Property Value
Type Description
FieldMask

GatewayListOptions

public GatewayListOptions GatewayListOptions { get; set; }

Options related to gateways.

Property Value
Type Description
GatewayListOptions

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsRegistryName

public RegistryName ParentAsRegistryName { get; set; }

RegistryName-typed view over the Parent resource name property.

Property Value
Type Description
RegistryName