com.google.cloud.iot.v1

Class ListDevicesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.iot.v1.ListDevicesRequest

All Implemented Interfaces:

ListDevicesRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class ListDevicesRequest
extends GeneratedMessageV3
implements ListDevicesRequestOrBuilder

 Request for `ListDevices`.
 

Protobuf type google.cloud.iot.v1.ListDevicesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDevicesRequest.Builder Request for `ListDevices`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEVICE_IDS_FIELD_NUMBER
static int	DEVICE_NUM_IDS_FIELD_NUMBER
static int	FIELD_MASK_FIELD_NUMBER
static int	GATEWAY_LIST_OPTIONS_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListDevicesRequest	getDefaultInstance()
ListDevicesRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
ProtocolStringList	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.
Parser<ListDevicesRequest>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	hasFieldMask() The fields of the `Device` resource to be returned in the response.
boolean	hasGatewayListOptions() Options related to gateways.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListDevicesRequest.Builder	newBuilder()
static ListDevicesRequest.Builder	newBuilder(ListDevicesRequest prototype)
ListDevicesRequest.Builder	newBuilderForType()
protected ListDevicesRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ListDevicesRequest	parseDelimitedFrom(InputStream input)
static ListDevicesRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ListDevicesRequest	parseFrom(byte[] data)
static ListDevicesRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ListDevicesRequest	parseFrom(ByteBuffer data)
static ListDevicesRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ListDevicesRequest	parseFrom(ByteString data)
static ListDevicesRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ListDevicesRequest	parseFrom(CodedInputStream input)
static ListDevicesRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ListDevicesRequest	parseFrom(InputStream input)
static ListDevicesRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ListDevicesRequest>	parser()
ListDevicesRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

DEVICE_NUM_IDS_FIELD_NUMBER

public static final int DEVICE_NUM_IDS_FIELD_NUMBER

See Also:

Constant Field Values

DEVICE_IDS_FIELD_NUMBER

public static final int DEVICE_IDS_FIELD_NUMBER

See Also:

Constant Field Values

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER

See Also:

Constant Field Values

GATEWAY_LIST_OPTIONS_FIELD_NUMBER

public static final int GATEWAY_LIST_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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) = { ... }

Specified by:

getParent in interface ListDevicesRequestOrBuilder

Returns:

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) = { ... }

Specified by:

getParentBytes in interface ListDevicesRequestOrBuilder

Returns:

The bytes for parent.

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;

Specified by:

getDeviceNumIdsList in interface ListDevicesRequestOrBuilder

Returns:

A list containing the deviceNumIds.

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;

Specified by:

getDeviceNumIdsCount in interface ListDevicesRequestOrBuilder

Returns:

The count of deviceNumIds.

getDeviceNumIds

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;

Specified by:

getDeviceNumIds in interface ListDevicesRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The deviceNumIds at the given index.

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;

Specified by:

getDeviceIdsList in interface ListDevicesRequestOrBuilder

Returns:

A list containing the deviceIds.

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;

Specified by:

getDeviceIdsCount in interface ListDevicesRequestOrBuilder

Returns:

The count of deviceIds.

getDeviceIds

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;

Specified by:

getDeviceIds in interface ListDevicesRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The deviceIds at the given index.

getDeviceIdsBytes

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;

Specified by:

getDeviceIdsBytes in interface ListDevicesRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the deviceIds at the given index.

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;

Specified by:

hasFieldMask in interface ListDevicesRequestOrBuilder

Returns:

Whether the fieldMask field is set.

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;

Specified by:

getFieldMask in interface ListDevicesRequestOrBuilder

Returns:

The fieldMask.

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;

Specified by:

getFieldMaskOrBuilder in interface ListDevicesRequestOrBuilder

hasGatewayListOptions

public boolean hasGatewayListOptions()

 Options related to gateways.
 

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

Specified by:

hasGatewayListOptions in interface ListDevicesRequestOrBuilder

Returns:

Whether the gatewayListOptions field is set.

getGatewayListOptions

public GatewayListOptions getGatewayListOptions()

 Options related to gateways.
 

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

Specified by:

getGatewayListOptions in interface ListDevicesRequestOrBuilder

Returns:

The gatewayListOptions.

getGatewayListOptionsOrBuilder

public GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder()

 Options related to gateways.
 

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

Specified by:

getGatewayListOptionsOrBuilder in interface ListDevicesRequestOrBuilder

getPageSize

public 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;

Specified by:

getPageSize in interface ListDevicesRequestOrBuilder

Returns:

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;

Specified by:

getPageToken in interface ListDevicesRequestOrBuilder

Returns:

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;

Specified by:

getPageTokenBytes in interface ListDevicesRequestOrBuilder

Returns:

The bytes for pageToken.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListDevicesRequest parseFrom(ByteBuffer data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(ByteBuffer data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(ByteString data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(ByteString data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(byte[] data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(byte[] data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDevicesRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ListDevicesRequest parseFrom(InputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListDevicesRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListDevicesRequest parseDelimitedFrom(InputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static ListDevicesRequest parseFrom(CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ListDevicesRequest parseFrom(CodedInputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public ListDevicesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListDevicesRequest.Builder newBuilder()

newBuilder

public static ListDevicesRequest.Builder newBuilder(ListDevicesRequest prototype)

toBuilder

public ListDevicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListDevicesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListDevicesRequest getDefaultInstance()

parser

public static Parser<ListDevicesRequest> parser()

getParserForType

public Parser<ListDevicesRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ListDevicesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder