Class ExecutePipelineResponse.Builder (3.35.1) 

public static final class ExecutePipelineResponse.Builder extends GeneratedMessageV3.Builder<ExecutePipelineResponse.Builder> implements ExecutePipelineResponseOrBuilder

The response for [Firestore.Execute][].

Protobuf type google.firestore.v1.ExecutePipelineResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutePipelineResponse.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllResults(Iterable<? extends Document> values)

public ExecutePipelineResponse.Builder addAllResults(Iterable<? extends Document> values)

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
values Iterable<? extends com.google.firestore.v1.Document>
Returns
Type Description
ExecutePipelineResponse.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutePipelineResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

addResults(Document value)

public ExecutePipelineResponse.Builder addResults(Document value)

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
value Document
Returns
Type Description
ExecutePipelineResponse.Builder

addResults(Document.Builder builderForValue)

public ExecutePipelineResponse.Builder addResults(Document.Builder builderForValue)

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
builderForValue Document.Builder
Returns
Type Description
ExecutePipelineResponse.Builder

addResults(int index, Document value)

public ExecutePipelineResponse.Builder addResults(int index, Document value)

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;

Parameters
Name Description
index int
value Document
Returns
Type Description
ExecutePipelineResponse.Builder

addResults(int index, Document.Builder builderForValue)

public ExecutePipelineResponse.Builder addResults(int index, Document.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Document.Builder
Returns
Type Description
ExecutePipelineResponse.Builder

addResultsBuilder()

public Document.Builder addResultsBuilder()

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
Document.Builder

addResultsBuilder(int index)

public Document.Builder addResultsBuilder(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.Builder

build()

public ExecutePipelineResponse build()
Returns
Type Description
ExecutePipelineResponse

buildPartial()

public ExecutePipelineResponse buildPartial()
Returns
Type Description
ExecutePipelineResponse

clear()

public ExecutePipelineResponse.Builder clear()
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

clearExecutionTime()

public ExecutePipelineResponse.Builder clearExecutionTime()

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
ExecutePipelineResponse.Builder

clearExplainStats()

public ExecutePipelineResponse.Builder clearExplainStats()

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
ExecutePipelineResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ExecutePipelineResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutePipelineResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

clearResults()

public ExecutePipelineResponse.Builder clearResults()

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
ExecutePipelineResponse.Builder

clearTransaction()

public ExecutePipelineResponse.Builder clearTransaction()

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
ExecutePipelineResponse.Builder

This builder for chaining.

clone()

public ExecutePipelineResponse.Builder clone()
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

getDefaultInstanceForType()

public ExecutePipelineResponse getDefaultInstanceForType()
Returns
Type Description
ExecutePipelineResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExecutionTimeBuilder()

public Timestamp.Builder getExecutionTimeBuilder()

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
Builder

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;

Returns
Type Description
TimestampOrBuilder

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;

Returns
Type Description
ExplainStats

The explainStats.

getExplainStatsBuilder()

public ExplainStats.Builder getExplainStatsBuilder()

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.Builder

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;

Returns
Type Description
ExplainStatsOrBuilder

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
Returns
Type Description
Document

getResultsBuilder(int index)

public Document.Builder getResultsBuilder(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.Builder

getResultsBuilderList()

public List<Document.Builder> getResultsBuilderList()

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<Builder>

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;

Returns
Type Description
List<Document>

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
Returns
Type Description
DocumentOrBuilder

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>

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExecutionTime(Timestamp value)

public ExecutePipelineResponse.Builder mergeExecutionTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExecutePipelineResponse.Builder

mergeExplainStats(ExplainStats value)

public ExecutePipelineResponse.Builder mergeExplainStats(ExplainStats value)

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;

Parameter
Name Description
value ExplainStats
Returns
Type Description
ExecutePipelineResponse.Builder

mergeFrom(ExecutePipelineResponse other)

public ExecutePipelineResponse.Builder mergeFrom(ExecutePipelineResponse other)
Parameter
Name Description
other ExecutePipelineResponse
Returns
Type Description
ExecutePipelineResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutePipelineResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecutePipelineResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutePipelineResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

removeResults(int index)

public ExecutePipelineResponse.Builder removeResults(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
ExecutePipelineResponse.Builder

setExecutionTime(Timestamp value)

public ExecutePipelineResponse.Builder setExecutionTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExecutePipelineResponse.Builder

setExecutionTime(Timestamp.Builder builderForValue)

public ExecutePipelineResponse.Builder setExecutionTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExecutePipelineResponse.Builder

setExplainStats(ExplainStats value)

public ExecutePipelineResponse.Builder setExplainStats(ExplainStats value)

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;

Parameter
Name Description
value ExplainStats
Returns
Type Description
ExecutePipelineResponse.Builder

setExplainStats(ExplainStats.Builder builderForValue)

public ExecutePipelineResponse.Builder setExplainStats(ExplainStats.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ExplainStats.Builder
Returns
Type Description
ExecutePipelineResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutePipelineResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecutePipelineResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides

setResults(int index, Document value)

public ExecutePipelineResponse.Builder setResults(int index, Document value)

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;

Parameters
Name Description
index int
value Document
Returns
Type Description
ExecutePipelineResponse.Builder

setResults(int index, Document.Builder builderForValue)

public ExecutePipelineResponse.Builder setResults(int index, Document.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Document.Builder
Returns
Type Description
ExecutePipelineResponse.Builder

setTransaction(ByteString value)

public ExecutePipelineResponse.Builder setTransaction(ByteString value)

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;

Parameter
Name Description
value ByteString

The transaction to set.
Returns
Type Description
ExecutePipelineResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutePipelineResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutePipelineResponse.Builder
Overrides