Skip to content

feat: graduate Pipeline and related APIs from beta to GA #2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wu-hui merged 1 commit into from
Apr 8, 2026
Merged

feat: graduate Pipeline and related APIs from beta to GA #2352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/ExplainStats.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package com.google.cloud.firestore;

import com.google.api.core.BetaApi;
import com.google.protobuf.Any;
import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.StringValue;
Expand All @@ -26,7 +25,6 @@
* A wrapper object to access explain stats if explain or analyze was enabled for the Pipeline query
* execution.
*/
@BetaApi
public final class ExplainStats {

private final Any explainStatsData;
Expand Down
8 changes: 0 additions & 8 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package com.google.cloud.firestore;

import com.google.api.core.BetaApi;
import com.google.api.gax.rpc.ApiException;
import com.google.api.gax.rpc.StatusCode;
import com.google.cloud.grpc.BaseGrpcServiceException;
Expand Down Expand Up @@ -58,7 +57,6 @@ private FirestoreException(IOException exception, boolean retryable) {
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forInvalidArgument(String message, Object... params) {
return new FirestoreException(String.format(message, params), Status.INVALID_ARGUMENT);
}
Expand All @@ -69,7 +67,6 @@ public static FirestoreException forInvalidArgument(String message, Object... pa
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forServerRejection(
Status status, String message, Object... params) {
return forServerRejection(status, null, message, params);
Expand All @@ -81,7 +78,6 @@ public static FirestoreException forServerRejection(
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forServerRejection(
Status status, @Nullable Throwable cause, String message, Object... params) {
return new FirestoreException(String.format(message, params), status, cause);
Expand All @@ -92,7 +88,6 @@ public static FirestoreException forServerRejection(
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forIOException(IOException exception, boolean retryable) {
return new FirestoreException(exception, retryable);
}
Expand All @@ -102,7 +97,6 @@ public static FirestoreException forIOException(IOException exception, boolean r
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forApiException(ApiException exception) {
return new FirestoreException(exception.getMessage(), exception);
}
Expand All @@ -112,12 +106,10 @@ public static FirestoreException forApiException(ApiException exception) {
*
* @return The FirestoreException
*/
@BetaApi
public static FirestoreException forApiException(ApiException exception, String message) {
return new FirestoreException(message, exception);
}

@BetaApi
@Nullable
public Status getStatus() {
return status;
Expand Down
2 changes: 0 additions & 2 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@

import com.google.api.core.ApiClock;
import com.google.api.core.ApiFuture;
import com.google.api.core.BetaApi;
import com.google.api.core.NanoClock;
import com.google.api.core.ObsoleteApi;
import com.google.api.core.SettableApiFuture;
Expand Down Expand Up @@ -419,7 +418,6 @@ public CollectionGroup collectionGroup(@Nonnull final String collectionId) {

@Nonnull
@Override
@BetaApi
public PipelineSource pipeline() {
return new PipelineSource(this);
}
Expand Down
2 changes: 0 additions & 2 deletions ...oud-firestore/src/main/java/com/google/cloud/firestore/FirestoreOpenTelemetryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package com.google.cloud.firestore;

import com.google.api.core.BetaApi;
import io.opentelemetry.api.OpenTelemetry;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
Expand All @@ -25,7 +24,6 @@
* Represents the options that are used to configure the use of OpenTelemetry for telemetry
* collection in the Firestore SDK.
*/
@BetaApi
public class FirestoreOpenTelemetryOptions {
private final boolean exportBuiltinMetricsToGoogleCloudMonitoring;
private final @Nullable OpenTelemetry openTelemetry;
Expand Down
3 changes: 0 additions & 3 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package com.google.cloud.firestore;

import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.core.InternalApi;
import com.google.api.gax.core.CredentialsProvider;
import com.google.api.gax.core.FixedCredentialsProvider;
Expand Down Expand Up @@ -159,7 +158,6 @@ com.google.cloud.firestore.telemetry.MetricsUtil getMetricsUtil() {
return metricsUtil;
}

@BetaApi
@Nonnull
public FirestoreOpenTelemetryOptions getOpenTelemetryOptions() {
return openTelemetryOptions;
Expand Down Expand Up @@ -277,7 +275,6 @@ public Builder setDatabaseId(@Nonnull String databaseId) {
*
* @param openTelemetryOptions The `FirestoreOpenTelemetryOptions` to use.
*/
@BetaApi
@Nonnull
public Builder setOpenTelemetryOptions(
@Nonnull FirestoreOpenTelemetryOptions openTelemetryOptions) {
Expand Down
30 changes: 0 additions & 30 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/Pipeline.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,11 @@
* .get();
* }</pre>
*/
@BetaApi
public final class Pipeline {
/**
* A Snapshot contains the results of a pipeline execution. It can be used to access the
* documents, execution time, and explain stats.
*/
@BetaApi
public static final class Snapshot {

private final Pipeline pipeline;
Expand Down Expand Up @@ -269,7 +267,6 @@ public Pipeline search(Search searchStage) {
* Selectable} expressions.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline addFields(Selectable field, Selectable... additionalFields) {
return append(
new AddFields(
Expand Down Expand Up @@ -503,7 +500,6 @@ public Expression toScalarExpression() {
* @param additionalFields The additional fields to remove.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline removeFields(String field, String... additionalFields) {
return append(
new RemoveFields(
Expand All @@ -528,7 +524,6 @@ public Pipeline removeFields(String field, String... additionalFields) {
* @param additionalFields The additional fields to remove.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline removeFields(Field field, Field... additionalFields) {
return append(
new RemoveFields(
Expand Down Expand Up @@ -568,7 +563,6 @@ public Pipeline removeFields(Field field, Field... additionalFields) {
* @param additionalSelections The additional fields to include in the output documents,
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline select(Selectable selection, Selectable... additionalSelections) {
return append(
new Select(
Expand Down Expand Up @@ -602,7 +596,6 @@ public Pipeline select(Selectable selection, Selectable... additionalSelections)
* @param additionalFields The additional fields to include in the output documents.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline select(String field, String... additionalFields) {
return append(
new Select(
Expand Down Expand Up @@ -646,7 +639,6 @@ public Pipeline select(String field, String... additionalFields) {
* @param condition The {@link BooleanExpression} to apply.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline where(BooleanExpression condition) {
return append(new Where(condition));
}
Expand All @@ -671,7 +663,6 @@ public Pipeline where(BooleanExpression condition) {
* @param offset The number of documents to skip.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline offset(int offset) {
return append(new Offset(offset));
}
Expand Down Expand Up @@ -701,7 +692,6 @@ public Pipeline offset(int offset) {
* @param limit The maximum number of documents to return.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline limit(int limit) {
return append(new Limit(limit));
}
Expand All @@ -727,7 +717,6 @@ public Pipeline limit(int limit) {
* AggregateFunction} and provide a name for the accumulated results.
* @return A new Pipeline object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline aggregate(AliasedAggregate... accumulators) {
return append(Aggregate.withAccumulators(accumulators));
}
Expand Down Expand Up @@ -765,12 +754,10 @@ public Pipeline aggregate(AliasedAggregate... accumulators) {
* the aggregation operations to perform.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline aggregate(Aggregate aggregate) {
return append(aggregate);
}

@BetaApi
public Pipeline aggregate(Aggregate aggregate, AggregateOptions options) {
return append(aggregate.withOptions(options));
}
Expand All @@ -792,7 +779,6 @@ public Pipeline aggregate(Aggregate aggregate, AggregateOptions options) {
* @param fields The fields to consider when determining distinct values.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline distinct(String... fields) {
return append(new Distinct(PipelineUtils.fieldNamesToMap(fields)));
}
Expand Down Expand Up @@ -824,7 +810,6 @@ public Pipeline distinct(String... fields) {
* value combinations.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline distinct(Selectable... selectables) {
return append(new Distinct(PipelineUtils.selectablesToMap(selectables)));
}
Expand Down Expand Up @@ -855,7 +840,6 @@ public Pipeline distinct(Selectable... selectables) {
* distance field name.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline findNearest(
String fieldName,
double[] vector,
Expand Down Expand Up @@ -893,7 +877,6 @@ public Pipeline findNearest(
* distance field name.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline findNearest(
Expression property,
double[] vector,
Expand Down Expand Up @@ -926,7 +909,6 @@ public Pipeline findNearest(
* @param orders One or more {@link Ordering} instances specifying the sorting criteria.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline sort(Ordering... orders) {
return append(new Sort(ImmutableList.copyOf(orders)));
}
Expand Down Expand Up @@ -962,7 +944,6 @@ public Pipeline sort(Ordering... orders) {
* @param fieldName The name of the field containing the nested map.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline replaceWith(String fieldName) {
return replaceWith(field(fieldName));
}
Expand Down Expand Up @@ -998,7 +979,6 @@ public Pipeline replaceWith(String fieldName) {
* @param expr The {@link Expression} field containing the nested map.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline replaceWith(Expression expr) {
return append(new ReplaceWith(expr));
}
Expand All @@ -1021,7 +1001,6 @@ public Pipeline replaceWith(Expression expr) {
* @param limit The number of documents to emit, if possible.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline sample(int limit) {
return sample(Sample.withDocLimit(limit));
}
Expand All @@ -1047,7 +1026,6 @@ public Pipeline sample(int limit) {
* @param sample The {@code Sample} specifies how sampling is performed.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline sample(Sample sample) {
return append(sample);
}
Expand Down Expand Up @@ -1110,7 +1088,6 @@ public Pipeline union(Pipeline other) {
* @param fieldName The name of the field containing the array.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline unnest(String fieldName, String alias) {
// return unnest(field(fieldName));
return append(new Unnest(field(fieldName), alias));
Expand Down Expand Up @@ -1148,7 +1125,6 @@ public Pipeline unnest(String fieldName, String alias) {
* @param options The {@code UnnestOptions} options.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline unnest(String fieldName, String alias, UnnestOptions options) {
return append(new Unnest(field(fieldName), alias, options));
}
Expand Down Expand Up @@ -1184,7 +1160,6 @@ public Pipeline unnest(String fieldName, String alias, UnnestOptions options) {
* @param expr The name of the expression containing the array.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline unnest(Selectable expr) {
return append(new Unnest(expr));
}
Expand Down Expand Up @@ -1221,7 +1196,6 @@ public Pipeline unnest(Selectable expr) {
* @param options The {@code UnnestOptions} options.
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline unnest(Selectable field, UnnestOptions options) {
return append(new Unnest(field, options));
}
Expand Down Expand Up @@ -1359,7 +1333,6 @@ public Pipeline update(Update update) {
*
* @return A new {@code Pipeline} object with this stage appended to the stage list.
*/
@BetaApi
public Pipeline rawStage(RawStage stage) {
return append(stage);
}
Expand Down Expand Up @@ -1395,12 +1368,10 @@ public Pipeline rawStage(RawStage stage) {
*
* @return An {@link ApiFuture} representing the asynchronous pipeline execution.
*/
@BetaApi
public ApiFuture<Snapshot> execute() {
return execute(new PipelineExecuteOptions(), null, null);
}

@BetaApi
public ApiFuture<Snapshot> execute(PipelineExecuteOptions options) {
return execute(options, null, null);
}
Expand Down Expand Up @@ -1454,7 +1425,6 @@ MetricsContext createMetricsContext(String methodName) {
*
* @param observer The {@link ApiStreamObserver} to receive pipeline results and events.
*/
@BetaApi
public void execute(ApiStreamObserver<PipelineResult> observer) {
if (this.rpcContext == null) {
throw new IllegalStateException(
Expand Down
Loading
Loading