Interface ListDevicesRequestOrBuilder (2.55.0) 

public interface ListDevicesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeviceIds(int index)

public abstract String getDeviceIds(int index)

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

repeated string device_ids = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The deviceIds at the given index.

getDeviceIdsBytes(int index)

public abstract ByteString getDeviceIdsBytes(int index)

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

repeated string device_ids = 3;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the deviceIds at the given index.

getDeviceIdsCount()

public abstract int getDeviceIdsCount()

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

repeated string device_ids = 3;

Returns
Type Description
int

The count of deviceIds.

getDeviceIdsList()

public abstract List<String> getDeviceIdsList()

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

repeated string device_ids = 3;

Returns
Type Description
List<String>

A list containing the deviceIds.

getDeviceNumIds(int index)

public abstract long getDeviceNumIds(int index)

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

repeated uint64 device_num_ids = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The deviceNumIds at the given index.

getDeviceNumIdsCount()

public abstract int getDeviceNumIdsCount()

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

repeated uint64 device_num_ids = 2;

Returns
Type Description
int

The count of deviceNumIds.

getDeviceNumIdsList()

public abstract List<Long> getDeviceNumIdsList()

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

repeated uint64 device_num_ids = 2;

Returns
Type Description
List<Long>

A list containing the deviceNumIds.

getFieldMask()

public abstract FieldMask getFieldMask()

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.

.google.protobuf.FieldMask field_mask = 4;

Returns
Type Description
FieldMask

The fieldMask.

getFieldMaskOrBuilder()

public abstract FieldMaskOrBuilder getFieldMaskOrBuilder()

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.

.google.protobuf.FieldMask field_mask = 4;

Returns
Type Description
FieldMaskOrBuilder

getGatewayListOptions()

public abstract GatewayListOptions getGatewayListOptions()

Options related to gateways.

.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;

Returns
Type Description
GatewayListOptions

The gatewayListOptions.

getGatewayListOptionsOrBuilder()

public abstract GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder()

Options related to gateways.

.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;

Returns
Type Description
GatewayListOptionsOrBuilder

getPageSize()

public abstract int getPageSize()

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.

int32 page_size = 100;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 101;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 101;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasFieldMask()

public abstract boolean hasFieldMask()

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.

.google.protobuf.FieldMask field_mask = 4;

Returns
Type Description
boolean

Whether the fieldMask field is set.

hasGatewayListOptions()

public abstract boolean hasGatewayListOptions()

Options related to gateways.

.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;

Returns
Type Description
boolean

Whether the gatewayListOptions field is set.