public final class ListDevicesRequest extends GeneratedMessageV3 implements ListDevicesRequestOrBuilder
Request for ListDevices.
Protobuf type google.cloud.iot.v1.ListDevicesRequest
Static Fields
DEVICE_IDS_FIELD_NUMBER
public static final int DEVICE_IDS_FIELD_NUMBER
Field Value
DEVICE_NUM_IDS_FIELD_NUMBER
public static final int DEVICE_NUM_IDS_FIELD_NUMBER
Field Value
FIELD_MASK_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
Field Value
GATEWAY_LIST_OPTIONS_FIELD_NUMBER
public static final int GATEWAY_LIST_OPTIONS_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListDevicesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListDevicesRequest.Builder newBuilder()
Returns
newBuilder(ListDevicesRequest prototype)
public static ListDevicesRequest.Builder newBuilder(ListDevicesRequest prototype)
Parameter
Returns
public static ListDevicesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListDevicesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListDevicesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListDevicesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListDevicesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDevicesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListDevicesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListDevicesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListDevicesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListDevicesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListDevicesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListDevicesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListDevicesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListDevicesRequest getDefaultInstanceForType()
Returns
getDeviceIds(int index)
public 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;
| 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 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;
| 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 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;
| Type | Description |
int | The count of deviceIds.
|
getDeviceIdsList()
public ProtocolStringList 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;
getDeviceNumIds(int index)
public 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;
| Name | Description |
index | int
The index of the element to return.
|
Returns
| Type | Description |
long | The deviceNumIds at the given index.
|
getDeviceNumIdsCount()
public int getDeviceNumIdsCount()
A list of device numeric IDs. If empty, this field is ignored. Maximum
IDs: 10,000.
repeated uint64 device_num_ids = 2;
| Type | Description |
int | The count of deviceNumIds.
|
getDeviceNumIdsList()
public 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;
| Type | Description |
List<Long> | A list containing the deviceNumIds.
|
getFieldMask()
public 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;
getFieldMaskOrBuilder()
public 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;
getGatewayListOptions()
public GatewayListOptions getGatewayListOptions()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;
getGatewayListOptionsOrBuilder()
public GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;
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;
| Type | Description |
int | The pageSize.
|
getPageToken()
public 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;
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public 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;
getParent()
public 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) = { ... }
| Type | Description |
String | The parent.
|
getParentBytes()
public 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) = { ... }
getParserForType()
public Parser<ListDevicesRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasFieldMask()
public 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;
| Type | Description |
boolean | Whether the fieldMask field is set.
|
hasGatewayListOptions()
public boolean hasGatewayListOptions()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;
| Type | Description |
boolean | Whether the gatewayListOptions field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListDevicesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListDevicesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListDevicesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
