public interface ExecutePipelineResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getExecutionTime()
public abstract 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 abstract 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;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getExplainStats()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ExplainStats |
The explainStats. |
getExplainStatsOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ExplainStatsOrBuilder |
|
getResults(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
Document |
|
getResultsCount()
public abstract 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 abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<Document> |
|
getResultsOrBuilder(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
DocumentOrBuilder |
|
getResultsOrBuilderList()
public abstract 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> |
|
getTransaction()
public abstract 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 abstract 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 abstract 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. |