Class ListDocumentsResponse (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public final class ListDocumentsResponse extends GeneratedMessageV3 implements ListDocumentsResponseOrBuilder

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

Static Fields

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListDocumentsResponse getDefaultInstance()
Returns
TypeDescription
ListDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListDocumentsResponse.Builder newBuilder()
Returns
TypeDescription
ListDocumentsResponse.Builder

newBuilder(ListDocumentsResponse prototype)

public static ListDocumentsResponse.Builder newBuilder(ListDocumentsResponse prototype)
Parameter
NameDescription
prototypeListDocumentsResponse
Returns
TypeDescription
ListDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListDocumentsResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListDocumentsResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDocumentsResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDocumentsResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListDocumentsResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListDocumentsResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListDocumentsResponse> parser()
Returns
TypeDescription
Parser<ListDocumentsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
ListDocumentsResponse

getDocuments(int index)

public Document getDocuments(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document

getDocumentsCount()

public int getDocumentsCount()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
TypeDescription
int

getDocumentsList()

public List<Document> getDocumentsList()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
TypeDescription
List<Document>

getDocumentsOrBuilder(int index)

public DocumentOrBuilder getDocumentsOrBuilder(int index)

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentOrBuilder

getDocumentsOrBuilderList()

public List<? extends DocumentOrBuilder> getDocumentsOrBuilderList()

The Documents found.

repeated .google.firestore.v1.Document documents = 1;

Returns
TypeDescription
List<? extends com.google.firestore.v1.DocumentOrBuilder>

getNextPageToken()

public String getNextPageToken()

The next page token.

string next_page_token = 2;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

The next page token.

string next_page_token = 2;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<ListDocumentsResponse> getParserForType()
Returns
TypeDescription
Parser<ListDocumentsResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListDocumentsResponse.Builder newBuilderForType()
Returns
TypeDescription
ListDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListDocumentsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListDocumentsResponse.Builder toBuilder()
Returns
TypeDescription
ListDocumentsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException