public final class RunQueryResponse extends GeneratedMessageV3 implements RunQueryResponseOrBuilderThe response for Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryResponse
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RunQueryResponseImplements
RunQueryResponseOrBuilderStatic Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER| Type | Description |
int |
DONE_FIELD_NUMBER
public static final int DONE_FIELD_NUMBER| Type | Description |
int |
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER| Type | Description |
int |
SKIPPED_RESULTS_FIELD_NUMBER
public static final int SKIPPED_RESULTS_FIELD_NUMBER| Type | Description |
int |
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static RunQueryResponse getDefaultInstance()| Type | Description |
RunQueryResponse |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static RunQueryResponse.Builder newBuilder()| Type | Description |
RunQueryResponse.Builder |
newBuilder(RunQueryResponse prototype)
public static RunQueryResponse.Builder newBuilder(RunQueryResponse prototype)| Name | Description |
prototype | RunQueryResponse |
| Type | Description |
RunQueryResponse.Builder |
parseDelimitedFrom(InputStream input)
public static RunQueryResponse parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static RunQueryResponse parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static RunQueryResponse parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static RunQueryResponse parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static RunQueryResponse parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static RunQueryResponse parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
RunQueryResponse |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<RunQueryResponse> parser()| Type | Description |
Parser<RunQueryResponse> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getContinuationSelectorCase()
public RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()| Type | Description |
RunQueryResponse.ContinuationSelectorCase |
getDefaultInstanceForType()
public RunQueryResponse getDefaultInstanceForType()| Type | Description |
RunQueryResponse |
getDocument()
public Document getDocument()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Type | Description |
Document | The document. |
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Type | Description |
DocumentOrBuilder |
getDone()
public boolean getDone()If present, Firestore has completely finished the request and no more documents will be returned.
bool done = 6;
| Type | Description |
boolean | The done. |
getParserForType()
public Parser<RunQueryResponse> getParserForType()| Type | Description |
Parser<RunQueryResponse> |
getReadTime()
public Timestamp getReadTime() The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their read_time and this one.
If the query returns no results, a response with read_time and no
document will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
| Type | Description |
Timestamp | The readTime. |
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder() The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their read_time and this one.
If the query returns no results, a response with read_time and no
document will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
| Type | Description |
TimestampOrBuilder |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
getSkippedResults()
public int getSkippedResults()The number of results that have been skipped due to an offset between the last response and the current response.
int32 skipped_results = 4;
| Type | Description |
int | The skippedResults. |
getTransaction()
public ByteString getTransaction()The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
bytes transaction = 2;
| Type | Description |
ByteString | The transaction. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
hasDocument()
public boolean hasDocument()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Type | Description |
boolean | Whether the document field is set. |
hasDone()
public boolean hasDone()If present, Firestore has completely finished the request and no more documents will be returned.
bool done = 6;
| Type | Description |
boolean | Whether the done field is set. |
hasReadTime()
public boolean hasReadTime() The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their read_time and this one.
If the query returns no results, a response with read_time and no
document will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
| Type | Description |
boolean | Whether the readTime field is set. |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public RunQueryResponse.Builder newBuilderForType()| Type | Description |
RunQueryResponse.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
RunQueryResponse.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public RunQueryResponse.Builder toBuilder()| Type | Description |
RunQueryResponse.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |