public final class ExecutePipelineResponse extends GeneratedMessageV3 implements ExecutePipelineResponseOrBuilder
The response for [Firestore.Execute][].
Protobuf type google.firestore.v1.ExecutePipelineResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXECUTION_TIME_FIELD_NUMBER
public static final int EXECUTION_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPLAIN_STATS_FIELD_NUMBER
public static final int EXPLAIN_STATS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExecutePipelineResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExecutePipelineResponse.Builder newBuilder()
newBuilder(ExecutePipelineResponse prototype)
public static ExecutePipelineResponse.Builder newBuilder(ExecutePipelineResponse prototype)
public static ExecutePipelineResponse parseDelimitedFrom(InputStream input)
public static ExecutePipelineResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExecutePipelineResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExecutePipelineResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineResponse parseFrom(CodedInputStream input)
public static ExecutePipelineResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineResponse parseFrom(InputStream input)
public static ExecutePipelineResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExecutePipelineResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExecutePipelineResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ExecutePipelineResponse getDefaultInstanceForType()
getExecutionTime()
public Timestamp getExecutionTime()
The time at which the results are valid.
This is a (not strictly) monotonically increasing value across multiple
responses in the same stream. The API guarantees that all previously
returned results are still valid at the latest execution_time. This
allows the API consumer to treat the query if it ran at the latest
execution_time returned.
If the query returns no results, a response with execution_time and no
results will be sent, and this represents the time at which the operation
was run.
.google.protobuf.Timestamp execution_time = 3;
| Returns |
| Type |
Description |
Timestamp |
The executionTime.
|
getExecutionTimeOrBuilder()
public TimestampOrBuilder getExecutionTimeOrBuilder()
The time at which the results are valid.
This is a (not strictly) monotonically increasing value across multiple
responses in the same stream. The API guarantees that all previously
returned results are still valid at the latest execution_time. This
allows the API consumer to treat the query if it ran at the latest
execution_time returned.
If the query returns no results, a response with execution_time and no
results will be sent, and this represents the time at which the operation
was run.
.google.protobuf.Timestamp execution_time = 3;
getExplainStats()
public ExplainStats getExplainStats()
Query explain stats.
This is present on the last response if the request configured explain
to run in 'analyze' or 'explain' mode in the pipeline options. If the query
does not return any results, a response with explain_stats and no
results will still be sent.
.google.firestore.v1.ExplainStats explain_stats = 4;
getExplainStatsOrBuilder()
public ExplainStatsOrBuilder getExplainStatsOrBuilder()
Query explain stats.
This is present on the last response if the request configured explain
to run in 'analyze' or 'explain' mode in the pipeline options. If the query
does not return any results, a response with explain_stats and no
results will still be sent.
.google.firestore.v1.ExplainStats explain_stats = 4;
getParserForType()
public Parser<ExecutePipelineResponse> getParserForType()
Overrides
getResults(int index)
public Document getResults(int index)
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like
name and
update_time. This is
explicitly a divergence from Firestore.RunQuery / Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask.
repeated .google.firestore.v1.Document results = 2;
| Parameter |
| Name |
Description |
index |
int
|
getResultsCount()
public int getResultsCount()
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like
name and
update_time. This is
explicitly a divergence from Firestore.RunQuery / Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask.
repeated .google.firestore.v1.Document results = 2;
| Returns |
| Type |
Description |
int |
|
getResultsList()
public List<Document> getResultsList()
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like
name and
update_time. This is
explicitly a divergence from Firestore.RunQuery / Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask.
repeated .google.firestore.v1.Document results = 2;
getResultsOrBuilder(int index)
public DocumentOrBuilder getResultsOrBuilder(int index)
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like
name and
update_time. This is
explicitly a divergence from Firestore.RunQuery / Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask.
repeated .google.firestore.v1.Document results = 2;
| Parameter |
| Name |
Description |
index |
int
|
getResultsOrBuilderList()
public List<? extends DocumentOrBuilder> getResultsOrBuilderList()
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like
name and
update_time. This is
explicitly a divergence from Firestore.RunQuery / Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask.
repeated .google.firestore.v1.Document results = 2;
| Returns |
| Type |
Description |
List<? extends com.google.firestore.v1.DocumentOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTransaction()
public ByteString getTransaction()
Newly created transaction identifier.
This field is only specified as part of the first response from the server,
alongside the results field when the original request specified
[ExecuteRequest.new_transaction][].
bytes transaction = 1;
| Returns |
| Type |
Description |
ByteString |
The transaction.
|
hasExecutionTime()
public boolean hasExecutionTime()
The time at which the results are valid.
This is a (not strictly) monotonically increasing value across multiple
responses in the same stream. The API guarantees that all previously
returned results are still valid at the latest execution_time. This
allows the API consumer to treat the query if it ran at the latest
execution_time returned.
If the query returns no results, a response with execution_time and no
results will be sent, and this represents the time at which the operation
was run.
.google.protobuf.Timestamp execution_time = 3;
| Returns |
| Type |
Description |
boolean |
Whether the executionTime field is set.
|
hasExplainStats()
public boolean hasExplainStats()
Query explain stats.
This is present on the last response if the request configured explain
to run in 'analyze' or 'explain' mode in the pipeline options. If the query
does not return any results, a response with explain_stats and no
results will still be sent.
.google.firestore.v1.ExplainStats explain_stats = 4;
| Returns |
| Type |
Description |
boolean |
Whether the explainStats field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExecutePipelineResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecutePipelineResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExecutePipelineResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
