com.google.cloud.iot.v1

Interface ListDevicesRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ListDevicesRequest, ListDevicesRequest.Builder

public interface ListDevicesRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDeviceIds(int index) A list of device string IDs.
ByteString	getDeviceIdsBytes(int index) A list of device string IDs.
int	getDeviceIdsCount() A list of device string IDs.
List<String>	getDeviceIdsList() A list of device string IDs.
long	getDeviceNumIds(int index) A list of device numeric IDs.
int	getDeviceNumIdsCount() A list of device numeric IDs.
List<Long>	getDeviceNumIdsList() A list of device numeric IDs.
FieldMask	getFieldMask() The fields of the `Device` resource to be returned in the response.
FieldMaskOrBuilder	getFieldMaskOrBuilder() The fields of the `Device` resource to be returned in the response.
GatewayListOptions	getGatewayListOptions() Options related to gateways.
GatewayListOptionsOrBuilder	getGatewayListOptionsOrBuilder() Options related to gateways.
int	getPageSize() The maximum number of devices to return in the response.
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.
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	getParent() Required.
ByteString	getParentBytes() Required.
boolean	hasFieldMask() The fields of the `Device` resource to be returned in the response.
boolean	hasGatewayListOptions() Options related to gateways.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

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:

The bytes for parent.

getDeviceNumIdsList

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:

A list containing the deviceNumIds.

getDeviceNumIdsCount

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:

The count of deviceNumIds.

getDeviceNumIds

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;

Parameters:

index - The index of the element to return.

Returns:

The deviceNumIds at the given index.

getDeviceIdsList

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:

A list containing the deviceIds.

getDeviceIdsCount

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:

The count of deviceIds.

getDeviceIds

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;

Parameters:

index - The index of the element to return.

Returns:

The deviceIds at the given index.

getDeviceIdsBytes

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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the deviceIds at the given index.

hasFieldMask

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:

Whether the fieldMask field is set.

getFieldMask

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:

The fieldMask.

getFieldMaskOrBuilder

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;

hasGatewayListOptions

boolean hasGatewayListOptions()

 Options related to gateways.
 

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

Returns:

Whether the gatewayListOptions field is set.

getGatewayListOptions

GatewayListOptions getGatewayListOptions()

 Options related to gateways.
 

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

Returns:

The gatewayListOptions.

getGatewayListOptionsOrBuilder

GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder()

 Options related to gateways.
 

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

getPageSize

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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

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:

The bytes for pageToken.