Class ListCollectionIdsRequest (3.21.3)

Version latest

• 3.21.3 (latest)
• 3.21.1
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public final class ListCollectionIdsRequest extends GeneratedMessageV3 implements ListCollectionIdsRequestOrBuilder

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListCollectionIdsRequest

Implements

ListCollectionIdsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ListCollectionIdsRequest getDefaultInstance()

Returns
Type	Description
ListCollectionIdsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ListCollectionIdsRequest.Builder newBuilder()

Returns
Type	Description
ListCollectionIdsRequest.Builder

newBuilder(ListCollectionIdsRequest prototype)

public static ListCollectionIdsRequest.Builder newBuilder(ListCollectionIdsRequest prototype)

Parameter
Name	Description
prototype	ListCollectionIdsRequest

Returns
Type	Description
ListCollectionIdsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ListCollectionIdsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCollectionIdsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCollectionIdsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ListCollectionIdsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ListCollectionIdsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListCollectionIdsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ListCollectionIdsRequest> parser()

Returns
Type	Description
Parser<ListCollectionIdsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getConsistencySelectorCase()

public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()

Returns
Type	Description
ListCollectionIdsRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public ListCollectionIdsRequest getDefaultInstanceForType()

Returns
Type	Description
ListCollectionIdsRequest

getPageSize()

public int getPageSize()

The maximum number of results to return.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<ListCollectionIdsRequest> getParserForType()

Returns
Type	Description
Parser<ListCollectionIdsRequest>

Overrides

GeneratedMessageV3.getParserForType()

getReadTime()

public Timestamp getReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
Timestamp	The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasReadTime()

public boolean hasReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
boolean	Whether the readTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ListCollectionIdsRequest.Builder newBuilderForType()

Returns
Type	Description
ListCollectionIdsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListCollectionIdsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ListCollectionIdsRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ListCollectionIdsRequest.Builder toBuilder()

Returns
Type	Description
ListCollectionIdsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException