Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abs() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the absolute value of this numeric expression.
- abs(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the absolute value of
numericExpr. - abs(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the absolute value of
numericField. - add(DocumentSnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
-
Adds a Firestore document snapshot to the bundle.
- add(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds numeric expressions.
- add(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds numeric expressions with a constant.
- add(Object) - Method in class com.google.cloud.firestore.CollectionReference
-
Adds a new document to this collection with the specified POJO as contents, assigning it a document ID automatically.
- add(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds this numeric expression to another numeric expression.
- add(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a numeric field with a numeric expression.
- add(String, QuerySnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
-
Adds a Firestore query snapshot to the bundle.
- add(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a numeric field with constant.
- add(Map<String, Object>) - Method in class com.google.cloud.firestore.CollectionReference
-
Adds a new document to this collection with the specified data, assigning it a document ID automatically.
- ADDED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type
-
Indicates a new document was added to the set of documents matching the query.
- addEvent(String) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Adds the given event to this span.
- addEvent(String, Map<String, Object>) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Adds the given event with the given attributes to this span.
- addFields(Selectable, Selectable...) - Method in class com.google.cloud.firestore.Pipeline
-
Adds new fields to outputs from previous stages.
- AddFields - Class in com.google.cloud.firestore.pipeline.stages
- AddFields(Map<String, Expression>) - Constructor for class com.google.cloud.firestore.pipeline.stages.AddFields
- adding(AbstractOptions<?>) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- addMetricsTracerFactory(List<ApiTracerFactory>) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil
-
Adds a metrics tracer factory to the given list of API tracer factories.
- addSnapshotListener(EventListener<DocumentSnapshot>) - Method in class com.google.cloud.firestore.DocumentReference
-
Starts listening to the document referenced by this DocumentReference.
- addSnapshotListener(EventListener<QuerySnapshot>) - Method in class com.google.cloud.firestore.Query
-
Starts listening to this query.
- addSnapshotListener(Executor, EventListener<DocumentSnapshot>) - Method in class com.google.cloud.firestore.DocumentReference
-
Starts listening to the document referenced by this DocumentReference.
- addSnapshotListener(Executor, EventListener<QuerySnapshot>) - Method in class com.google.cloud.firestore.Query
-
Starts listening to this query.
- addWriteErrorListener(BulkWriter.WriteErrorCallback) - Method in class com.google.cloud.firestore.BulkWriter
-
Attaches an error handler listener that is run every time a BulkWriter operation fails.
- addWriteErrorListener(Executor, BulkWriter.WriteErrorCallback) - Method in class com.google.cloud.firestore.BulkWriter
-
Attaches an error handler listener that is run every time a BulkWriter operation fails.
- addWriteResultListener(BulkWriter.WriteResultCallback) - Method in class com.google.cloud.firestore.BulkWriter
-
Attaches a listener that is run every time a BulkWriter operation successfully completes.
- addWriteResultListener(Executor, BulkWriter.WriteResultCallback) - Method in class com.google.cloud.firestore.BulkWriter
-
Attaches a listener that is run every time a BulkWriter operation successfully completes.
- aggregate(AggregateField, AggregateField...) - Method in class com.google.cloud.firestore.Query
-
Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.
- aggregate(AliasedAggregate...) - Method in class com.google.cloud.firestore.Pipeline
-
Performs aggregation operations on the documents from previous stages.
- aggregate(Aggregate) - Method in class com.google.cloud.firestore.Pipeline
-
Performs optionally grouped aggregation operations on the documents from previous stages.
- aggregate(Aggregate, AggregateOptions) - Method in class com.google.cloud.firestore.Pipeline
- Aggregate - Class in com.google.cloud.firestore.pipeline.stages
- AggregateField - Class in com.google.cloud.firestore
-
Represents an aggregation that can be performed by Firestore.
- AggregateField() - Constructor for class com.google.cloud.firestore.AggregateField
- AggregateField.AverageAggregateField - Class in com.google.cloud.firestore
-
Represents an "average" aggregation that can be performed by Firestore.
- AggregateField.CountAggregateField - Class in com.google.cloud.firestore
-
Represents a "count" aggregation that can be performed by Firestore.
- AggregateField.SumAggregateField - Class in com.google.cloud.firestore
-
Represents a "sum" aggregation that can be performed by Firestore.
- AggregateFunction - Class in com.google.cloud.firestore.pipeline.expressions
-
A class that represents an aggregate function.
- aggregateFunctionToValue(AggregateFunction) - Static method in class com.google.cloud.firestore.pipeline.expressions.FunctionUtils
- AggregateHints - Class in com.google.cloud.firestore.pipeline.stages
- AggregateHints() - Constructor for class com.google.cloud.firestore.pipeline.stages.AggregateHints
- AggregateOptions - Class in com.google.cloud.firestore.pipeline.stages
- AggregateOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.AggregateOptions
- AggregateQuery - Class in com.google.cloud.firestore
-
A query that calculates aggregations over an underlying query.
- AggregateQuerySnapshot - Class in com.google.cloud.firestore
-
The results of executing an
AggregateQuery. - AliasedAggregate - Class in com.google.cloud.firestore.pipeline.expressions
- AliasedExpression - Class in com.google.cloud.firestore.pipeline.expressions
- ANALYZE - Static variable in class com.google.cloud.firestore.pipeline.stages.ExplainOptions.ExecutionMode
- and(Filter...) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter that is a conjunction of the given filters.
- and(BooleanExpression, BooleanExpression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a logical 'AND' operation.
- apply(ManagedChannelBuilder) - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator
- applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Applies the given settings updater function to all of the unary API methods in this service.
- applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Applies the given settings updater function to all of the unary API methods in this service.
- array(Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that creates a Firestore array value from an input object.
- array(List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that creates a Firestore array value from an input object.
- arrayAgg() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that collects all values of this expression across multiple stage inputs into an array.
- arrayAgg(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that collects all values of an expression across multiple stage inputs into an array.
- arrayAgg(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that collects all values of a field across multiple stage inputs into an array.
- arrayAggDistinct() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that collects all distinct values of this expression across multiple stage inputs into an array.
- arrayAggDistinct(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that collects all distinct values of an expression across multiple stage inputs into an array.
- arrayAggDistinct(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that collects all distinct values of a field across multiple stage inputs into an array.
- arrayConcat(Expression...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates a field's array value with other arrays.
- arrayConcat(Expression, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates multiple arrays into a single array.
- arrayConcat(String, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates multiple arrays into a single array.
- arrayContains(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given array field contains the given value.
- arrayContains(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains a specified element.
- arrayContains(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains a specified element.
- arrayContains(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if array contains a specific
element. - arrayContains(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains a specified element.
- arrayContains(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given array field contains the given value.
- arrayContains(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains a specified element.
- arrayContainsAll(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if array contains all elements of
arrayExpression. - arrayContainsAll(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains all of the elements of another array.
- arrayContainsAll(Expression, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains all of the provided values.
- arrayContainsAll(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains all of the elements of another array.
- arrayContainsAll(String, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains all of the provided values.
- arrayContainsAll(List<Object>) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if array contains all the specified
values. - arrayContainsAny(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given array field contains any of the given values.
- arrayContainsAny(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if array contains any elements of
arrayExpression. - arrayContainsAny(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains any of the elements of another array.
- arrayContainsAny(Expression, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains any of the provided values.
- arrayContainsAny(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains any of the elements of another array.
- arrayContainsAny(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given array field contains any of the given values.
- arrayContainsAny(String, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an array contains any of the provided values.
- arrayContainsAny(List<Object>) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if array contains any of the specified
values. - arrayFirst() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the first element of an array.
- arrayFirst(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first element of an array.
- arrayFirst(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first element of an array.
- arrayFirstN(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the first n elements of an array.
- arrayFirstN(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the first n elements of an array.
- arrayFirstN(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first n elements of an array.
- arrayFirstN(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first n elements of an array.
- arrayFirstN(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first n elements of an array.
- arrayFirstN(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first n elements of an array.
- arrayGet(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that indexes into an array from the beginning or end and return the element.
- arrayGet(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that indexes into an array from the beginning or end and return the element.
- arrayGet(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns an element from an array at a specified index.
- arrayGet(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns an element from an array at a specified index.
- arrayGet(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns an element from an array at a specified index.
- arrayGet(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns an element from an array at a specified index.
- arrayIndexOf(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the index of the first occurrence of a value in an array.
- arrayIndexOf(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the first occurrence of a value in an array.
- arrayIndexOf(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the first occurrence of a value in an array.
- arrayIndexOf(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the index of the first occurrence of a value in an array.
- arrayIndexOf(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the first occurrence of a value in an array.
- arrayIndexOf(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the first occurrence of a value in an array.
- arrayIndexOfAll(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns all indices of a value in an array.
- arrayIndexOfAll(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns all indices of a value in an array.
- arrayIndexOfAll(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns all indices of a value in an array.
- arrayIndexOfAll(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns all indices of a value in an array.
- arrayIndexOfAll(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns all indices of a value in an array.
- arrayIndexOfAll(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns all indices of a value in an array.
- arrayLast() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the last element of an array.
- arrayLast(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last element of an array.
- arrayLast(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last element of an array.
- arrayLastIndexOf(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the index of the last occurrence of a value in an array.
- arrayLastIndexOf(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the last occurrence of a value in an array.
- arrayLastIndexOf(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the last occurrence of a value in an array.
- arrayLastIndexOf(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the index of the last occurrence of a value in an array.
- arrayLastIndexOf(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the last occurrence of a value in an array.
- arrayLastIndexOf(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the index of the last occurrence of a value in an array.
- arrayLastN(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the last n elements of an array.
- arrayLastN(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the last n elements of an array.
- arrayLastN(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last n elements of an array.
- arrayLastN(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last n elements of an array.
- arrayLastN(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last n elements of an array.
- arrayLastN(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the last n elements of an array.
- arrayLength() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of an array expression.
- arrayLength(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the length of an array.
- arrayLength(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the length of an array.
- arrayMaximum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the maximum value of an array.
- arrayMaximum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the maximum value of an array.
- arrayMaximum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the maximum value of an array.
- arrayMaximumN(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the n maximum values of an array.
- arrayMaximumN(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the n maximum values of an array.
- arrayMaximumN(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n maximum values of an array.
- arrayMaximumN(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n maximum values of an array.
- arrayMaximumN(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n maximum values of an array.
- arrayMaximumN(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n maximum values of an array.
- arrayMinimum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the minimum value of an array.
- arrayMinimum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the minimum value of an array.
- arrayMinimum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the minimum value of an array.
- arrayMinimumN(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the n minimum values of an array.
- arrayMinimumN(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Returns the n minimum values of an array.
- arrayMinimumN(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n minimum values of an array.
- arrayMinimumN(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n minimum values of an array.
- arrayMinimumN(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n minimum values of an array.
- arrayMinimumN(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the n minimum values of an array.
- arrayRemove(Object...) - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a special value that can be used with set(), create() or update() that tells the server to remove the given elements from any array value that already exists on the server.
- arrayReverse() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Reverses the order of elements in the array.
- arrayReverse(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that reverses an array.
- arrayReverse(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that reverses an array.
- ArraySortedMap<K,
V> - Class in com.google.cloud.firestore.collection -
This is an array backed implementation of ImmutableSortedMap.
- ArraySortedMap(Comparator<K>) - Constructor for class com.google.cloud.firestore.collection.ArraySortedMap
- arraySum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the sum of the elements of this array expression.
- arraySum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the sum of the elements of an array.
- arraySum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the sum of the elements of an array.
- arrayUnion(Object...) - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a special value that can be used with set(), create() or update() that tells the server to union the given elements with any array value that already exists on the server.
- as(String) - Method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Assigns an alias to this aggregate.
- as(String) - Method in class com.google.cloud.firestore.pipeline.expressions.AliasedExpression
-
Creates a new
AliasedExpressionthat wraps this expression and associates it with the given alias. - as(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Assigns an alias to this expression.
- ascending() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create an
Orderingthat sorts documents in ascending order based on value of this expression - ascending(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Ordering
- ASCENDING - Enum constant in enum com.google.cloud.firestore.pipeline.expressions.Ordering.Direction
- ASCENDING - Enum constant in enum com.google.cloud.firestore.Query.Direction
- ATTRIBUTE_GCP_RESOURCE_NAME - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_GCP_RESOURCE_NAME_FORMAT - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_ATTEMPT - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_ATTEMPTS_ALLOWED - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_ATTEMPTS_REMAINING - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_DOC_COUNT - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_IS_RETRY_WITH_CURSOR - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_IS_TRANSACTIONAL - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_NUM_RESPONSES - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_KEY_TRANSACTION_TYPE - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- ATTRIBUTE_SERVICE_PREFIX - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- autoBuild() - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
- autoId() - Static method in class com.google.cloud.firestore.Internal
- average() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that calculates the average (mean) of this numeric expression across multiple stage inputs.
- average(FieldPath) - Static method in class com.google.cloud.firestore.AggregateField
-
Create an
AggregateField.AverageAggregateFieldobject that can be used to compute the average of a specified field over a range of documents in the result set of a query. - average(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that calculates the average (mean) of values from an expression across multiple stage inputs.
- average(String) - Static method in class com.google.cloud.firestore.AggregateField
-
Create an
AggregateField.AverageAggregateFieldobject that can be used to compute the average of a specified field over a range of documents in the result set of a query. - average(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that calculates the average (mean) of a field's values across multiple stage inputs.
- awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.FirestoreClient
- awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
B
- BasePath<B extends BasePath<B>> - Class in com.google.cloud.firestore
-
BasePath represents a path sequence in the Firestore database.
- BasePath() - Constructor for class com.google.cloud.firestore.BasePath
- batch() - Method in interface com.google.cloud.firestore.Firestore
-
Gets a Firestore
WriteBatchinstance that can be used to combine multiple writes. - batchGetDocumentsCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Gets multiple documents.
- batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Gets multiple documents.
- batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to batchGetDocuments.
- batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to batchGetDocuments.
- batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to batchGetDocuments.
- batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to batchGetDocuments.
- batchWrite(BatchWriteRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Applies a batch of write operations.
- batchWriteCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
- batchWriteCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- batchWriteCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Applies a batch of write operations.
- batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- batchWriteSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to batchWrite.
- batchWriteSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to batchWrite.
- batchWriteSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to batchWrite.
- batchWriteSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to batchWrite.
- beginTransaction(BeginTransactionRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Starts a new transaction.
- beginTransaction(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Starts a new transaction.
- beginTransactionCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Starts a new transaction.
- beginTransactionCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Starts a new transaction.
- beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to beginTransaction.
- beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to beginTransaction.
- beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to beginTransaction.
- beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to beginTransaction.
- BLACK - Enum constant in enum com.google.cloud.firestore.collection.LLRBNode.Color
- Blob - Class in com.google.cloud.firestore
-
Immutable class representing an array of bytes in Firestore.
- BooleanExpression - Class in com.google.cloud.firestore.pipeline.expressions
- build() - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
- build() - Method in class com.google.cloud.firestore.ExplainOptions.Builder
- build() - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
- build() - Method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions.Builder
- build() - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
- build() - Method in class com.google.cloud.firestore.TransactionOptions.Builder
- build() - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder
- build() - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder
- build() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- build() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
- build() - Method in class com.google.cloud.firestore.VectorQueryOptions.Builder
- builder() - Static method in class com.google.cloud.firestore.BulkWriterOptions
- builder() - Static method in class com.google.cloud.firestore.ExplainOptions
- Builder() - Constructor for class com.google.cloud.firestore.BulkWriterOptions.Builder
- Builder() - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
- Builder() - Constructor for class com.google.cloud.firestore.ExplainOptions.Builder
- Builder() - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- Builder() - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
- Builder(ClientContext) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- Builder(ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
- Builder(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- Builder(FirestoreStubSettings) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
- Builder(FirestoreStubSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- Builder(Executor) - Constructor for class com.google.cloud.firestore.TransactionOptions.Builder
- buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ArraySortedMap
- buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
- buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- bulkWriter() - Method in interface com.google.cloud.firestore.Firestore
-
Creates a
BulkWriterinstance, used for performing multiple writes in parallel. - bulkWriter(BulkWriterOptions) - Method in interface com.google.cloud.firestore.Firestore
-
Creates a
BulkWriterinstance, used for performing multiple writes in parallel. - BulkWriter - Class in com.google.cloud.firestore
-
A Firestore BulkWriter that can be used to perform a large number of writes in parallel.
- BulkWriter.WriteErrorCallback - Interface in com.google.cloud.firestore
-
A callback set by `addWriteErrorListener()` to be run every time an operation fails and determines if an operation should be retried.
- BulkWriter.WriteResultCallback - Interface in com.google.cloud.firestore
-
A callback set by `addWriteResultListener()` to be run every time an operation successfully completes.
- BulkWriterException - Exception in com.google.cloud.firestore
-
The error thrown when a BulkWriter operation fails.
- BulkWriterException(Status, String, DocumentReference, BulkWriter.OperationType, int) - Constructor for exception com.google.cloud.firestore.BulkWriterException
- BulkWriterOptions - Class in com.google.cloud.firestore
-
Options used to configure request throttling in BulkWriter.
- BulkWriterOptions() - Constructor for class com.google.cloud.firestore.BulkWriterOptions
- BulkWriterOptions.Builder - Class in com.google.cloud.firestore
- bundleBuilder() - Method in interface com.google.cloud.firestore.Firestore
-
Returns a FirestoreBundle.Builder
FirestoreBundle.Builderinstance using an automatically generated bundle ID. - bundleBuilder(String) - Method in interface com.google.cloud.firestore.Firestore
-
Returns a FirestoreBundle.Builder
FirestoreBundle.Builderinstance for the given bundle ID. - byteLength() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.
- byteLength(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.
- byteLength(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of a string represented by a field in UTF-8 bytes, or just the length of a Blob.
C
- ceil() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest integer that isn't less than this numeric expression.
- ceil(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest integer that isn't less than
numericExpr. - ceil(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest integer that isn't less than
numericField. - charLength() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the character length of this string expression in UTF8.
- charLength(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the character length of a string expression in UTF8.
- charLength(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the character length of a string field in UTF8.
- className() - Method in class com.google.cloud.firestore.Transaction
- className() - Method in class com.google.cloud.firestore.UpdateBuilder
- close() - Method in class com.google.cloud.firestore.BulkWriter
-
Commits all enqueued writes and marks the BulkWriter instance as closed.
- close() - Method in interface com.google.cloud.firestore.Firestore
-
Closes the gRPC channels associated with this instance and frees up their resources.
- close() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- close() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Scope
-
Closes the current scope.
- close() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- close() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- close() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- close() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- collection(CollectionReference) - Method in class com.google.cloud.firestore.PipelineSource
- collection(String) - Method in class com.google.cloud.firestore.DocumentReference
-
Gets a CollectionReference instance that refers to the collection that is a child of this document.
- collection(String) - Method in interface com.google.cloud.firestore.Firestore
-
Gets a
CollectionReferencethat refers to the collection at the specified path. - collection(String) - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinethat operates on the specified Firestore collection. - collection(String, CollectionOptions) - Method in class com.google.cloud.firestore.PipelineSource
- Collection - Class in com.google.cloud.firestore.pipeline.stages
- Collection(String, CollectionOptions) - Constructor for class com.google.cloud.firestore.pipeline.stages.Collection
- collectionGroup(String) - Method in interface com.google.cloud.firestore.Firestore
-
Creates and returns a new
CollectionGroupthat includes all documents in the database that are contained in a collection or subcollection with the given @code{collectionId}. - collectionGroup(String) - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinethat operates on all documents in a collection group. - collectionGroup(String, CollectionGroupOptions) - Method in class com.google.cloud.firestore.PipelineSource
- CollectionGroup - Class in com.google.cloud.firestore
-
A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID.
- CollectionGroup - Class in com.google.cloud.firestore.pipeline.stages
- CollectionGroup(String, CollectionGroupOptions) - Constructor for class com.google.cloud.firestore.pipeline.stages.CollectionGroup
- CollectionGroupOptions - Class in com.google.cloud.firestore.pipeline.stages
- CollectionGroupOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.CollectionGroupOptions
- CollectionHints - Class in com.google.cloud.firestore.pipeline.stages
- CollectionHints() - Constructor for class com.google.cloud.firestore.pipeline.stages.CollectionHints
- collectionId() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the collection ID from this path expression.
- collectionId(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the collection ID from a path.
- collectionId(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the collection ID from a path.
- CollectionOptions - Class in com.google.cloud.firestore.pipeline.stages
- CollectionOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.CollectionOptions
- CollectionReference - Class in com.google.cloud.firestore
-
A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).
- com.google.cloud.firestore - package com.google.cloud.firestore
- com.google.cloud.firestore.annotation - package com.google.cloud.firestore.annotation
- com.google.cloud.firestore.collection - package com.google.cloud.firestore.collection
- com.google.cloud.firestore.encoding - package com.google.cloud.firestore.encoding
- com.google.cloud.firestore.pipeline.expressions - package com.google.cloud.firestore.pipeline.expressions
- com.google.cloud.firestore.pipeline.stages - package com.google.cloud.firestore.pipeline.stages
- com.google.cloud.firestore.spi.v1 - package com.google.cloud.firestore.spi.v1
- com.google.cloud.firestore.telemetry - package com.google.cloud.firestore.telemetry
- com.google.cloud.firestore.v1 - package com.google.cloud.firestore.v1
-
A client to Cloud Firestore API
- com.google.cloud.firestore.v1.stub - package com.google.cloud.firestore.v1.stub
- commit() - Method in class com.google.cloud.firestore.WriteBatch
-
Applies the current WriteBatch and returns an array with WriteResults.
- commit(CommitRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Commits a transaction, while optionally updating documents.
- commit(String, List<Write>) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Commits a transaction, while optionally updating documents.
- commitCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Commits a transaction, while optionally updating documents.
- commitCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- commitCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Commits a transaction, while optionally updating documents.
- commitCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- commitCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- commitCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- commitSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to commit.
- commitSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to commit.
- commitSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to commit.
- commitSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to commit.
- committed - Variable in class com.google.cloud.firestore.UpdateBuilder
- COMMON_ATTRIBUTES - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- compareTo(B) - Method in class com.google.cloud.firestore.BasePath
-
Compare the current path against another Path object.
- CompositeApiTracerFactory - Class in com.google.cloud.firestore.telemetry
-
Combines multiple
ApiTracerFactoryinto a singleApiTracerFactory. - CompositeApiTracerFactory(List<ApiTracerFactory>) - Constructor for class com.google.cloud.firestore.telemetry.CompositeApiTracerFactory
- concat(Expression, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates expressions together.
- concat(Object...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates this expression with other values.
- concat(String, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates expressions together.
- conditional(BooleanExpression, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates a conditional expression that evaluates to a
thenExprexpression if a condition is true or anelseExprexpression if the condition is false. - conditional(BooleanExpression, Object, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates a conditional expression that evaluates to a
thenValueif a condition is true or anelseValueif the condition is false. - conditional(Expression, Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates a conditional expression that evaluates to a
thenExprexpression if this condition is true or anelseExprexpression if the condition is false. - conditional(Object, Object) - Method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates a conditional expression that evaluates to a
thenValueif this condition is true or anelseValueif the condition is false. - constant(byte[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a bytes value.
- constant(Blob) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Blobvalue. - constant(DocumentReference) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
DocumentReferencevalue. - constant(GeoPoint) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
GeoPointvalue. - constant(VectorValue) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
VectorValuevalue. - constant(Timestamp) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Timestampvalue. - constant(Boolean) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Booleanvalue. - constant(Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Numbervalue. - constant(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Stringvalue. - constant(Date) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create a constant for a
Datevalue. - contains(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns whether or not the field exists in the document.
- contains(FieldPath) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns whether or not the field exists in the document.
- contains(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns whether or not the field exists in the document.
- contains(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns whether or not the field exists in the document.
- contains(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- containsKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- containsKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- containsKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- convertToCustomClass(Object, Class<T>, DocumentReference) - Static method in class com.google.cloud.firestore.encoding.CustomClassMapper
-
Converts a standard library Java representation of JSON data to an object of the provided class.
- convertToPlainJavaTypes(Object) - Static method in class com.google.cloud.firestore.encoding.CustomClassMapper
-
Converts a Java representation of JSON data to standard library Java data types: Map, Array, String, Double, Integer and Boolean.
- convertToPlainJavaTypes(Map<?, Object>) - Static method in class com.google.cloud.firestore.encoding.CustomClassMapper
- copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode
- copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode
- copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- COSINE - Enum constant in enum com.google.cloud.firestore.VectorQuery.DistanceMeasure
-
COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors' magnitude.
- COSINE - Static variable in class com.google.cloud.firestore.pipeline.stages.FindNearest.DistanceMeasure
- cosineDistance(double[]) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the Cosine distance between this vector expression and a vector literal.
- cosineDistance(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the Cosine distance between this and another vector expressions.
- cosineDistance(Expression, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the cosine distance between two vectors.
- cosineDistance(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the cosine distance between two vectors.
- cosineDistance(String, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the cosine distance between two vectors.
- cosineDistance(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the cosine distance between two vectors.
- count() - Static method in class com.google.cloud.firestore.AggregateField
-
Create a
AggregateField.CountAggregateFieldobject that can be used to compute the count of documents in the result set of a query. - count() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that counts the number of stage inputs with valid evaluations of the this expression.
- count() - Method in class com.google.cloud.firestore.Query
-
Returns a query that counts the documents in the result set of this query.
- count(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the number of stage inputs with valid evaluations of the provided
expression. - count(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the number of stage inputs where the input field exists.
- countAll() - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the total number of stage inputs.
- countDistinct() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that counts the number of distinct values of this expression.
- countDistinct(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the number of distinct values of an expression across multiple stage inputs.
- countDistinct(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the number of distinct values of a field across multiple stage inputs.
- countIf() - Method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates an aggregation that counts the number of stage inputs where the this boolean expression evaluates to true.
- countIf(BooleanExpression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that counts the number of stage inputs where the provided boolean expression evaluates to true.
- create() - Static method in class com.google.cloud.firestore.TransactionOptions
-
Create a default set of options suitable for most use cases.
- create() - Static method in class com.google.cloud.firestore.v1.FirestoreClient
-
Constructs an instance of FirestoreClient with default settings.
- create(int) - Static method in class com.google.cloud.firestore.TransactionOptions
-
Deprecated.
- create(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- create(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- create(ClientContext, GrpcStubCallableFactory) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- create(ClientContext, HttpJsonStubCallableFactory) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- create(DocumentReference, Object) - Method in class com.google.cloud.firestore.BulkWriter
-
Create a document with the provided data.
- create(DocumentReference, Object) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Creates a new Document at the DocumentReference location.
- create(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter
-
Create a document with the provided data.
- create(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Creates a new Document at the DocumentReference's location.
- create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory
- create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory
- create(FirestoreSettings) - Static method in class com.google.cloud.firestore.v1.FirestoreClient
-
Constructs an instance of FirestoreClient, using the given settings.
- create(FirestoreStub) - Static method in class com.google.cloud.firestore.v1.FirestoreClient
-
Constructs an instance of FirestoreClient, using the given stub for making calls.
- create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
- create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- create(Object) - Method in class com.google.cloud.firestore.DocumentReference
-
Creates a new Document at the DocumentReference location.
- create(Executor) - Static method in class com.google.cloud.firestore.TransactionOptions
-
Deprecated.as of 2.0.0, replaced by
TransactionOptions.Builder.setExecutor(Executor) - create(Executor, int) - Static method in class com.google.cloud.firestore.TransactionOptions
-
Deprecated.as of 2.0.0, replaced by
TransactionOptions.Builder.setExecutor(Executor)andTransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int) - create(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference
-
Creates a new Document at the DocumentReference's Location.
- createAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPagedResponse
- createAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPagedResponse
- createAsync(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, ApiFuture<PartitionQueryResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPagedResponse
- createBatchingCallable(GrpcCallSettings<RequestT, ResponseT>, BatchingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createBatchingCallable(HttpJsonCallSettings<RequestT, ResponseT>, BatchingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- createBidiStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, StreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createClientStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, StreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createCollection(List<FirestoreClient.ListCollectionIdsPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsFixedSizeCollection
- createCollection(List<FirestoreClient.ListDocumentsPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsFixedSizeCollection
- createCollection(List<FirestoreClient.PartitionQueryPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryFixedSizeCollection
- createDocument(CreateDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Creates a new document.
- createDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Creates a new document.
- createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- createDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to createDocument.
- createDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to createDocument.
- createDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to createDocument.
- createDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to createDocument.
- createFrom(AggregateQuery) - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinefrom the givenAggregateQuery. - createFrom(Query) - Method in class com.google.cloud.firestore.PipelineSource
- createMetricsContext(String) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil
-
Creates a new
MetricsContextfor the given method and starts timing. - createOperationCallable(GrpcCallSettings<RequestT, Operation>, OperationCallSettings<RequestT, ResponseT, MetadataT>, ClientContext, OperationsStub) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createOperationCallable(HttpJsonCallSettings<RequestT, Operation>, OperationCallSettings<RequestT, ResponseT, MetadataT>, ClientContext, OperationsStub) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- createPage(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ListCollectionIdsResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPage
- createPage(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ListDocumentsResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPage
- createPage(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, PartitionQueryResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPage
- createPageAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPage
- createPageAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPage
- createPageAsync(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, ApiFuture<PartitionQueryResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPage
- createPagedCallable(GrpcCallSettings<RequestT, ResponseT>, PagedCallSettings<RequestT, ResponseT, PagedListResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createPagedCallable(HttpJsonCallSettings<RequestT, ResponseT>, PagedCallSettings<RequestT, ResponseT, PagedListResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- createQuery() - Method in class com.google.cloud.firestore.QueryPartition
-
Returns a query that only returns the documents for this partition.
- createReadOnlyOptionsBuilder() - Static method in class com.google.cloud.firestore.TransactionOptions
- createReadWriteOptionsBuilder() - Static method in class com.google.cloud.firestore.TransactionOptions
- createServerStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createServerStreamingCallable(HttpJsonCallSettings<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- createStub() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- createUnaryCallable(GrpcCallSettings<RequestT, ResponseT>, UnaryCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- createUnaryCallable(HttpJsonCallSettings<RequestT, ResponseT>, UnaryCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- currentContext() - Method in class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- currentContext() - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- currentContext() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Returns the current Context.
- currentSpan() - Method in class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- currentSpan() - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- currentSpan() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Returns the current span.
- currentTimestamp() - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the current timestamp.
- CustomClassMapper - Class in com.google.cloud.firestore.encoding
-
Helper class to convert to/from custom POJO classes and plain Java types.
- CustomClassMapper() - Constructor for class com.google.cloud.firestore.encoding.CustomClassMapper
D
- database() - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinethat operates on all documents in the Firestore database. - Database - Class in com.google.cloud.firestore.pipeline.stages
- Database() - Constructor for class com.google.cloud.firestore.pipeline.stages.Database
- defaultApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
- defaultApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- defaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder for the default credentials for this service.
- defaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder for the default credentials for this service.
- defaultExecutorProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder for the default ExecutorProvider for this service.
- defaultExecutorProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder for the default ExecutorProvider for this service.
- DefaultFirestoreFactory() - Constructor for class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory
- DefaultFirestoreRpcFactory() - Constructor for class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory
- defaultGrpcApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder for the default gRPC ChannelProvider for this service.
- defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder for the default gRPC ChannelProvider for this service.
- defaultHttpJsonApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- defaultHttpJsonTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder for the default REST ChannelProvider for this service.
- defaultHttpJsonTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder for the default REST ChannelProvider for this service.
- defaultTransportChannelProvider() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
- defaultTransportChannelProvider() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- delete() - Method in class com.google.cloud.firestore.DocumentReference
-
Deletes the document referred to by this DocumentReference.
- delete() - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a sentinel used with update() to mark a field for deletion.
- delete(DocumentReference) - Method in class com.google.cloud.firestore.BulkWriter
-
Delete a document from the database.
- delete(DocumentReference) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Deletes the document referred to by this DocumentReference.
- delete(DocumentReference, Precondition) - Method in class com.google.cloud.firestore.BulkWriter
-
Delete a document from the database.
- delete(DocumentReference, Precondition) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Deletes the document referred to by this DocumentReference.
- delete(Precondition) - Method in class com.google.cloud.firestore.DocumentReference
-
Deletes the document referred to by this DocumentReference.
- deleteDocument(DeleteDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Deletes a document.
- deleteDocument(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Deletes a document.
- deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Deletes a document.
- deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to deleteDocument.
- deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to deleteDocument.
- deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to deleteDocument.
- deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to deleteDocument.
- descending() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Create an
Orderingthat sorts documents in descending order based on value of this expression - descending(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Ordering
- DESCENDING - Enum constant in enum com.google.cloud.firestore.pipeline.expressions.Ordering.Direction
- DESCENDING - Enum constant in enum com.google.cloud.firestore.Query.Direction
- DisabledTraceUtil - Class in com.google.cloud.firestore.telemetry
-
A no-op implementation of
MetricsUtilthat does not collect or export any metrics and has near-zero overhead. - DisabledTraceUtil() - Constructor for class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- distinct(Selectable...) - Method in class com.google.cloud.firestore.Pipeline
-
Returns a set of distinct
Expressionvalues from the inputs to this stage. - distinct(String...) - Method in class com.google.cloud.firestore.Pipeline
-
Returns a set of distinct field values from the inputs to this stage.
- Distinct - Class in com.google.cloud.firestore.pipeline.stages
- Distinct(Map<String, Expression>) - Constructor for class com.google.cloud.firestore.pipeline.stages.Distinct
- divide(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that divides two numeric expressions.
- divide(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that divides a numeric expression by a constant.
- divide(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that divides this numeric expression by another numeric expression.
- divide(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that divides numeric field by a numeric expression.
- divide(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that divides a numeric field by a constant.
- document() - Method in class com.google.cloud.firestore.CollectionReference
-
Returns a DocumentReference pointing to a new document with an auto-generated ID within this collection.
- document(String) - Method in class com.google.cloud.firestore.CollectionReference
-
Gets a DocumentReference instance that refers to the document that is a child of this Collection.
- document(String) - Method in interface com.google.cloud.firestore.Firestore
-
Gets a
DocumentReferencethat refers to the document at the specified path. - DOCUMENT_ID - Static variable in class com.google.cloud.firestore.pipeline.expressions.Field
- DocumentChange - Class in com.google.cloud.firestore
-
A DocumentChange represents a change to the documents matching a query.
- DocumentChange.Type - Enum in com.google.cloud.firestore
-
An enumeration of snapshot diff types.
- documentId() - Static method in class com.google.cloud.firestore.FieldPath
-
A special sentinel to refer to the ID of a document.
- documentId() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the document ID from this path expression.
- documentId(DocumentReference) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the document ID from a
DocumentReference. - documentId(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the document ID from a path.
- documentId(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the document ID from a path.
- DocumentId - Annotation Type in com.google.cloud.firestore.annotation
-
Annotation used to mark a POJO property to be automatically populated with the document's ID when the POJO is created from a Cloud Firestore document (for example, via
DocumentSnapshot.toObject(java.lang.Class<T>)). - DocumentReference - Class in com.google.cloud.firestore
-
A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location.
- documents(DocumentReference...) - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinethat operates on a specific set of Firestore documents. - documents(String...) - Method in class com.google.cloud.firestore.PipelineSource
-
Creates a new
Pipelinethat operates on a specific set of Firestore documents. - Documents - Class in com.google.cloud.firestore.pipeline.stages
- DOCUMENTS - Enum constant in enum com.google.cloud.firestore.pipeline.stages.Sample.Mode
- DocumentSnapshot - Class in com.google.cloud.firestore
-
A DocumentSnapshot contains data read from a document in a Firestore database.
- DOT_PRODUCT - Enum constant in enum com.google.cloud.firestore.VectorQuery.DistanceMeasure
-
Similar to cosine but is affected by the magnitude of the vectors.
- DOT_PRODUCT - Static variable in class com.google.cloud.firestore.pipeline.stages.FindNearest.DistanceMeasure
- dotProduct(double[]) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the dot product distance between this vector expression and a vector literal.
- dotProduct(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the dot product distance between this and another vector expression.
- dotProduct(Expression, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the dot product of two vectors.
- dotProduct(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the dot product of two vectors.
- dotProduct(String, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the dot product of two vectors.
- dotProduct(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the dot product of two vectors.
E
- emptyMap(Comparator<K>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
- EmulatorCredentials() - Constructor for class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- ENABLE_METRICS_ENV_VAR - Static variable in interface com.google.cloud.firestore.telemetry.MetricsUtil
- ENABLE_TRACING_ENV_VAR - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- EnabledTraceUtil - Class in com.google.cloud.firestore.telemetry
-
A utility class that uses OpenTelemetry for trace collection.
- EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator - Class in com.google.cloud.firestore.telemetry
- encodeValue(boolean) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(double) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(long) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(AggregateFunction) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(Expression) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(Object) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(String) - Static method in class com.google.cloud.firestore.PipelineUtils
- encodeValue(Map<String, Value>) - Static method in class com.google.cloud.firestore.PipelineUtils
- end() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Ends this span.
- end(Throwable) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Ends this span in an error.
- END_TO_END_LATENCY - Enum constant in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
- endAt(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that ends at the provided document (inclusive).
- endAt(Object...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that ends at the provided fields relative to the order of the query.
- endAtFuture(ApiFuture<T>) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
If an operation ends in the future, its relevant span should end _after_ the future has been completed.
- endBefore(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that ends before the provided document (exclusive).
- endBefore(Object...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that ends before the provided fields relative to the order of the query.
- endsWith(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression ends with a given
suffix. - endsWith(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression ends with a given
suffix. - endsWith(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this string expression ends with a given
suffix. - endsWith(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression ends with a given
suffix. - endsWith(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression ends with a given
suffix. - equal(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if two expressions are equal.
- equal(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is equal to a constant value.
- equal(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is equal to a
value. - equal(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is equal to an expression.
- equal(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is equal to a constant value.
- equalAny(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an
expression, when evaluated, is equal to any of the elements ofarrayExpression. - equalAny(Expression, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an
expression, when evaluated, is equal to any of the providedvalues. - equalAny(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field's value is equal to any of the elements of
arrayExpression. - equalAny(String, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field's value is equal to any of the provided
values. - equalAny(List<Object>) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression, when evaluated, is equal to any of the provided
values. - equals(Object) - Method in class com.google.cloud.firestore.AggregateField
-
Returns true if the given object is equal to this object.
- equals(Object) - Method in class com.google.cloud.firestore.AggregateQuery
-
Compares this object with the given object for equality.
- equals(Object) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Compares this object with the given object for equality.
- equals(Object) - Method in class com.google.cloud.firestore.Blob
-
Returns true if this Blob is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- equals(Object) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- equals(Object) - Method in class com.google.cloud.firestore.DocumentChange
-
Returns true if this DocumentChange is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.DocumentReference
-
Returns true if this DocumentReference is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns true if the document's data and path in this DocumentSnapshot equals the provided snapshot.
- equals(Object) - Method in class com.google.cloud.firestore.FieldValue
-
Returns true if this FieldValue is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.FirestoreOptions
- equals(Object) - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Tests for equality with this object.
- equals(Object) - Method in class com.google.cloud.firestore.GeoPoint
-
Returns true if this GeoPoint is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Field
- equals(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.FunctionExpression
- equals(Object) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns true if the document's data and path in this DocumentSnapshot equals the provided snapshot.
- equals(Object) - Method in class com.google.cloud.firestore.Precondition
-
Returns true if this Precondition is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.Query
-
Returns true if this Query is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.QueryPartition
- equals(Object) - Method in class com.google.cloud.firestore.SetOptions
-
Returns true if this SetOptions is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.VectorQuery
-
Returns true if this VectorQuery is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.VectorQueryOptions
-
Returns true if this VectorQueryOptions is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.VectorValue
-
Returns true if this VectorValue is equal to the provided object.
- equals(Object) - Method in class com.google.cloud.firestore.WriteResult
-
Returns true if this WriteResult is equal to the provided object.
- equalTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is equal to the given value.
- equalTo(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is equal to the given value.
- EUCLIDEAN - Enum constant in enum com.google.cloud.firestore.VectorQuery.DistanceMeasure
-
Measures the EUCLIDEAN distance between the vectors.
- EUCLIDEAN - Static variable in class com.google.cloud.firestore.pipeline.stages.FindNearest.DistanceMeasure
- euclideanDistance(double[]) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the Euclidean distance between this vector expression and a vector literal.
- euclideanDistance(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Calculates the Euclidean distance between this and another vector expression.
- euclideanDistance(Expression, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the Euclidean distance between two vectors.
- euclideanDistance(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the Euclidean distance between two vectors.
- euclideanDistance(String, double[]) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the Euclidean distance between two vectors.
- euclideanDistance(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the Euclidean distance between two vectors.
- EventListener<T> - Interface in com.google.cloud.firestore
-
An interface for event listeners.
- Exclude - Annotation Type in com.google.cloud.firestore.annotation
-
Marks a field as excluded from the Database.
- execute() - Method in class com.google.cloud.firestore.Pipeline
-
Executes this pipeline and returns a future to represent the asynchronous operation.
- execute(ApiStreamObserver<PipelineResult>) - Method in class com.google.cloud.firestore.Pipeline
-
Executes this pipeline, providing results to the given
ApiStreamObserveras they become available. - execute(Pipeline) - Method in class com.google.cloud.firestore.Transaction
-
Executes the provided pipeline within the transaction context.
- execute(PipelineExecuteOptions) - Method in class com.google.cloud.firestore.Pipeline
- execute(Pipeline, PipelineExecuteOptions) - Method in class com.google.cloud.firestore.Transaction
-
Executes the provided pipeline with specified options, within the transaction context.
- executePipelineCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Executes a pipeline.
- executePipelineCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- executePipelineCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Executes a pipeline query.
- executePipelineCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- executePipelineCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- executePipelineCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- executePipelineSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to executePipeline.
- executePipelineSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to executePipeline.
- executePipelineSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to executePipeline.
- executePipelineSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to executePipeline.
- ExecutionStats - Class in com.google.cloud.firestore
-
A ExecutionStats contains information about the execution of a query.
- executor - Variable in class com.google.cloud.firestore.TransactionOptions.Builder
- exists() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns whether or not the field exists in the document.
- exists() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression evaluates to a name of the field that exists.
- exists() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns whether or not the field exists in the document.
- exists(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field exists.
- exists(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field exists.
- exp() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns Euler's number e raised to the power of this numeric expression.
- exp(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns Euler's number e raised to the power of
numericExpr. - exp(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns Euler's number e raised to the power of
numericField. - explain(ExplainOptions) - Method in class com.google.cloud.firestore.AggregateQuery
-
Plans and optionally executes this query.
- explain(ExplainOptions) - Method in class com.google.cloud.firestore.Query
-
Plans and optionally executes this query.
- explain(ExplainOptions) - Method in class com.google.cloud.firestore.StreamableQuery
-
Plans and optionally executes this query.
- explain(ExplainOptions) - Method in class com.google.cloud.firestore.VectorQuery
-
Plans and optionally executes this VectorQuery.
- EXPLAIN - Static variable in class com.google.cloud.firestore.pipeline.stages.ExplainOptions.ExecutionMode
- ExplainMetrics - Class in com.google.cloud.firestore
-
ExplainMetrics contains information about planning and execution of a query.
- ExplainOptions - Class in com.google.cloud.firestore
-
Options used to configure explain queries.
- ExplainOptions - Class in com.google.cloud.firestore.pipeline.stages
- ExplainOptions() - Constructor for class com.google.cloud.firestore.ExplainOptions
- ExplainOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.ExplainOptions
- ExplainOptions.Builder - Class in com.google.cloud.firestore
- ExplainOptions.ExecutionMode - Class in com.google.cloud.firestore.pipeline.stages
- ExplainResults<T> - Class in com.google.cloud.firestore
-
ExplainResults contains information about planning, execution, and results of a query.
- ExplainStats - Class in com.google.cloud.firestore
-
A wrapper object to access explain stats if explain or analyze was enabled for the Pipeline query execution.
- explainStream(ExplainOptions, ApiStreamObserver<DocumentSnapshot>) - Method in class com.google.cloud.firestore.Query
-
Executes the query, streams the results as a StreamObserver of DocumentSnapshots, and returns an ApiFuture that will be resolved with the associated
ExplainMetrics. - exportBuiltinMetricsToGoogleCloudMonitoring() - Method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions
- Expression - Class in com.google.cloud.firestore.pipeline.expressions
-
Represents an expression that can be evaluated to a value within the execution of a
Pipeline. - exprToValue(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.FunctionUtils
F
- field(FieldPath) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates a
Fieldinstance representing the field at the given path. - field(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates a
Fieldinstance representing the field at the given path. - Field - Class in com.google.cloud.firestore.pipeline.expressions
-
Represents a reference to a field in a Firestore document.
- FieldMask - Class in com.google.cloud.firestore
-
A FieldMask can be used to limit the number of fields returned by a `getAll()` call.
- fieldNamesToMap(String...) - Static method in class com.google.cloud.firestore.PipelineUtils
- FieldPath - Class in com.google.cloud.firestore
-
A
FieldPathrefers to a field in a document. - FieldPath() - Constructor for class com.google.cloud.firestore.FieldPath
- FieldValue - Class in com.google.cloud.firestore
-
Sentinel values that can be used when writing document fields with set() or update().
- Filter - Class in com.google.cloud.firestore
- Filter() - Constructor for class com.google.cloud.firestore.Filter
- findNearest(FieldPath, VectorValue, int, VectorQuery.DistanceMeasure) - Method in class com.google.cloud.firestore.Query
-
Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.
- findNearest(FieldPath, VectorValue, int, VectorQuery.DistanceMeasure, VectorQueryOptions) - Method in class com.google.cloud.firestore.Query
-
Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.
- findNearest(Expression, double[], FindNearest.DistanceMeasure, FindNearestOptions) - Method in class com.google.cloud.firestore.Pipeline
-
Performs vector distance (similarity) search with given parameters to the stage inputs.
- findNearest(String, double[], int, VectorQuery.DistanceMeasure) - Method in class com.google.cloud.firestore.Query
-
Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.
- findNearest(String, double[], int, VectorQuery.DistanceMeasure, VectorQueryOptions) - Method in class com.google.cloud.firestore.Query
-
Returns a VectorQuery that can perform vector distance (similarity) search with given parameters.
- findNearest(String, double[], FindNearest.DistanceMeasure, FindNearestOptions) - Method in class com.google.cloud.firestore.Pipeline
-
Performs vector distance (similarity) search with given parameters to the stage inputs.
- FindNearest - Class in com.google.cloud.firestore.pipeline.stages
- FindNearest(Expression, VectorValue, FindNearest.DistanceMeasure, FindNearestOptions) - Constructor for class com.google.cloud.firestore.pipeline.stages.FindNearest
- FindNearest.DistanceMeasure - Class in com.google.cloud.firestore.pipeline.stages
- FindNearestOptions - Class in com.google.cloud.firestore.pipeline.stages
- FindNearestOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- Firestore - Interface in com.google.cloud.firestore
-
Represents a Firestore Database and is the entry point for all Firestore operations
- FIRESTORE_METER_NAME - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- FIRESTORE_METRICS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- FIRESTORE_RESOURCE_LABELS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- FIRESTORE_RESOURCE_TYPE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- FirestoreBundle - Class in com.google.cloud.firestore
-
Represents a Firestore data bundle with results from the given document and query snapshots.
- FirestoreBundle.Builder - Class in com.google.cloud.firestore
-
Builds a Firestore data bundle with results from the given document and query snapshots.
- FirestoreClient - Class in com.google.cloud.firestore.v1
-
Service Description: The Cloud Firestore service.
- FirestoreClient(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1.FirestoreClient
-
Constructs an instance of FirestoreClient, using the given settings.
- FirestoreClient(FirestoreStub) - Constructor for class com.google.cloud.firestore.v1.FirestoreClient
- FirestoreClient.ListCollectionIdsFixedSizeCollection - Class in com.google.cloud.firestore.v1
- FirestoreClient.ListCollectionIdsPage - Class in com.google.cloud.firestore.v1
- FirestoreClient.ListCollectionIdsPagedResponse - Class in com.google.cloud.firestore.v1
- FirestoreClient.ListDocumentsFixedSizeCollection - Class in com.google.cloud.firestore.v1
- FirestoreClient.ListDocumentsPage - Class in com.google.cloud.firestore.v1
- FirestoreClient.ListDocumentsPagedResponse - Class in com.google.cloud.firestore.v1
- FirestoreClient.PartitionQueryFixedSizeCollection - Class in com.google.cloud.firestore.v1
- FirestoreClient.PartitionQueryPage - Class in com.google.cloud.firestore.v1
- FirestoreClient.PartitionQueryPagedResponse - Class in com.google.cloud.firestore.v1
- FirestoreException - Exception in com.google.cloud.firestore
-
A Firestore Service exception.
- FirestoreFactory - Interface in com.google.cloud.firestore
-
An interface for Firestore factories.
- FirestoreOpenTelemetryOptions - Class in com.google.cloud.firestore
-
Represents the options that are used to configure the use of OpenTelemetry for telemetry collection in the Firestore SDK.
- FirestoreOpenTelemetryOptions.Builder - Class in com.google.cloud.firestore
- FirestoreOptions - Class in com.google.cloud.firestore
-
A Factory class to create new Firestore instances.
- FirestoreOptions(FirestoreOptions.Builder) - Constructor for class com.google.cloud.firestore.FirestoreOptions
- FirestoreOptions.Builder - Class in com.google.cloud.firestore
- FirestoreOptions.DefaultFirestoreFactory - Class in com.google.cloud.firestore
- FirestoreOptions.DefaultFirestoreRpcFactory - Class in com.google.cloud.firestore
- FirestoreOptions.EmulatorCredentials - Class in com.google.cloud.firestore
- FirestoreRpc - Interface in com.google.cloud.firestore.spi.v1
-
Contains the RPC stubs used by the manual Cloud Firestore client.
- FirestoreRpcFactory - Interface in com.google.cloud.firestore
-
An interface for Firestore RPC factory.
- FirestoreSettings - Class in com.google.cloud.firestore.v1
-
Settings class to configure an instance of
FirestoreClient. - FirestoreSettings(FirestoreSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings
- FirestoreSettings.Builder - Class in com.google.cloud.firestore.v1
-
Builder for FirestoreSettings.
- FirestoreStub - Class in com.google.cloud.firestore.v1.stub
-
Base stub class for the Firestore service API.
- FirestoreStub() - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStub
- FirestoreStubSettings - Class in com.google.cloud.firestore.v1.stub
-
Settings class to configure an instance of
FirestoreStub. - FirestoreStubSettings(FirestoreStubSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- FirestoreStubSettings.Builder - Class in com.google.cloud.firestore.v1.stub
-
Builder for FirestoreStubSettings.
- first() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that finds the first value of this expression across multiple stage inputs.
- first(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the first value of an expression across multiple stage inputs.
- first(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the first value of a field across multiple stage inputs.
- FIRST_RESPONSE_LATENCY - Enum constant in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
- floor() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest integer that isn't less than this numeric expression.
- floor(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest integer that isn't less than
numericExpr. - floor(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest integer that isn't less than
numericField. - flush() - Method in class com.google.cloud.firestore.BulkWriter
-
Commits all writes that have been enqueued up to this point in parallel.
- forApiException(ApiException) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException from an ApiException.
- forApiException(ApiException, String) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException from an ApiException.
- forInvalidArgument(String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException with an
INVALID_ARGUMENTstatus code and the provided message in a nested exception. - forIOException(IOException, boolean) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException from an IOException.
- forServerRejection(Status, String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.
- forServerRejection(Status, Throwable, String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException
-
Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.
- fromBytes(byte[]) - Static method in class com.google.cloud.firestore.Blob
-
Creates a new Blob instance from the provided bytes.
- fromByteString(ByteString) - Static method in class com.google.cloud.firestore.Blob
-
Creates a new Blob instance from the provided ByteString.
- fromDotSeparatedString(String) - Static method in class com.google.cloud.firestore.FieldPath
-
Returns a field path from a dot separated string.
- fromMap(Map<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
- fromMap(Map<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- fromMap(Map<K, V>, Comparator<K>) - Static method in class com.google.cloud.firestore.collection.ArraySortedMap
- fromProto(Firestore, RunAggregationQueryRequest) - Static method in class com.google.cloud.firestore.AggregateQuery
-
Returns an AggregateQuery instance that can be used to execute the provided
RunAggregationQueryRequest. - fromProto(Firestore, RunQueryRequest) - Static method in class com.google.cloud.firestore.Query
-
Returns a Query instance that can be used to execute the provided
RunQueryRequest. - fromServerFormat(String) - Static method in class com.google.cloud.firestore.FieldPath
-
Creates a
FieldPathfrom a server-encoded field path. - FULL_REPLACE - Enum constant in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
- FunctionExpression - Class in com.google.cloud.firestore.pipeline.expressions
- FunctionUtils - Class in com.google.cloud.firestore.pipeline.expressions
- FunctionUtils() - Constructor for class com.google.cloud.firestore.pipeline.expressions.FunctionUtils
G
- GAX_METER_NAME - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- GAX_METRICS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- generic(String) - Static method in class com.google.cloud.firestore.pipeline.stages.FindNearest.DistanceMeasure
- GenericQuerySnapshot<QueryT> - Class in com.google.cloud.firestore
-
Abstract.
- GenericQuerySnapshot(QueryT, Timestamp, List<QueryDocumentSnapshot>, List<DocumentChange>) - Constructor for class com.google.cloud.firestore.GenericQuerySnapshot
- GeoPoint - Class in com.google.cloud.firestore
-
Immutable class representing a geographic location in Firestore
- GeoPoint(double, double) - Constructor for class com.google.cloud.firestore.GeoPoint
-
Construct a new GeoPoint using the provided latitude and longitude values.
- get() - Method in class com.google.cloud.firestore.AggregateQuery
-
Executes this query.
- get() - Method in class com.google.cloud.firestore.DocumentReference
-
Reads the document referenced by this DocumentReference.
- get() - Method in class com.google.cloud.firestore.Query
-
Executes the query and returns the results as QuerySnapshot.
- get() - Method in class com.google.cloud.firestore.StreamableQuery
-
Executes the query and returns the results as QuerySnapshot.
- get() - Method in class com.google.cloud.firestore.VectorQuery
-
Executes the query and returns the results as
QuerySnapshot. - get(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the result of the given aggregation from the server without coercion of data types.
- get(AggregateField.AverageAggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the result of the given average aggregation.
- get(AggregateField.CountAggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the number of documents in the result set of the underlying query.
- get(AggregateQuery) - Method in class com.google.cloud.firestore.Transaction
-
Returns the result from the provided aggregate query.
- get(DocumentReference) - Method in class com.google.cloud.firestore.Transaction
-
Reads the document referred to by the provided DocumentReference.
- get(FieldMask) - Method in class com.google.cloud.firestore.DocumentReference
-
Reads the document referenced by this DocumentReference.
- get(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value at the field or null if the field doesn't exist.
- get(FieldPath) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value at the field or null if the field doesn't exist.
- get(FieldPath, Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
- get(FieldPath, Class<T>) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value at the field, converted to a POJO, or null if the field or result doesn't exist.
- get(Query) - Method in class com.google.cloud.firestore.Transaction
-
Returns the result set from the provided query.
- get(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value at the field or null if the field doesn't exist.
- get(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value at the field or null if the field doesn't exist.
- get(String, Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
- get(String, Class<T>) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value at the field, converted to a POJO, or null if the field or result doesn't exist.
- get(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- get(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- get(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getAlias() - Method in class com.google.cloud.firestore.pipeline.expressions.AliasedAggregate
- getAlias() - Method in class com.google.cloud.firestore.pipeline.expressions.AliasedExpression
- getAll(DocumentReference...) - Method in interface com.google.cloud.firestore.Firestore
-
Retrieves multiple documents from Firestore.
- getAll(DocumentReference...) - Method in class com.google.cloud.firestore.Transaction
-
Retrieves multiple documents from Firestore.
- getAll(DocumentReference[], FieldMask) - Method in interface com.google.cloud.firestore.Firestore
-
Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted.
- getAll(DocumentReference[], FieldMask) - Method in class com.google.cloud.firestore.Transaction
-
Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted from the backend.
- getAll(DocumentReference[], FieldMask, ApiStreamObserver<DocumentSnapshot>) - Method in interface com.google.cloud.firestore.Firestore
-
Retrieves multiple documents from Firestore while optionally applying a field mask to reduce the amount of data transmitted.
- getAnalyze() - Method in class com.google.cloud.firestore.ExplainOptions
-
Returns whether analyzing the query is enabled.
- getApiTracerFactory() - Method in class com.google.cloud.firestore.FirestoreOptions
- getAuthenticationType() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- getBlob(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a Blob.
- getBlob(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a Blob.
- getBoolean(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a boolean.
- getBoolean(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a boolean.
- getChannelConfigurator() - Method in class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- getChannelConfigurator() - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- getChannelConfigurator() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Returns a channel configurator for gRPC, or
nullif tracing is disabled. - getColor() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode
- getColor() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode
- getColor() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getComparator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- getComparator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- getComparator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getCount() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the number of documents in the result set of the underlying query.
- getCreateTime() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the time at which this document was created.
- getCreateTime() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the time at which this document was created.
- getCredentialsProvider() - Method in class com.google.cloud.firestore.FirestoreOptions
- getData() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the fields of the document as a Map or null if the document doesn't exist.
- getData() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the fields of the result as a Map or null if the result doesn't exist.
- getData() - Method in class com.google.cloud.firestore.QueryDocumentSnapshot
-
Returns the fields of the document as a Map.
- getDatabaseId() - Method in class com.google.cloud.firestore.FirestoreOptions
- getDate(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a Date.
- getDate(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a Date.
- getDebugStats() - Method in class com.google.cloud.firestore.ExecutionStats
-
Returns a map that contains additional statistics related to query execution.
- getDefaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions
- getDefaultEndpoint() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the default service endpoint.
- getDefaultEndpoint() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the default service endpoint.
- getDefaultHost() - Method in class com.google.cloud.firestore.FirestoreOptions
- getDefaultInstance() - Static method in class com.google.cloud.firestore.FirestoreOptions
-
Returns a default
FirestoreOptionsinstance. - getDefaultMtlsEndpoint() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the default mTLS service endpoint.
- getDefaultServiceScopes() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the default service scopes.
- getDefaultServiceScopes() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the default service scopes.
- getDefaultTransportChannelProviderBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions
- getDefaultTransportOptionsBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions
- getDir() - Method in class com.google.cloud.firestore.pipeline.expressions.Ordering
- getDistanceResultField() - Method in class com.google.cloud.firestore.VectorQueryOptions
- getDistanceThreshold() - Method in class com.google.cloud.firestore.VectorQueryOptions
- getDocument() - Method in class com.google.cloud.firestore.DocumentChange
-
Returns the newly added or modified document if this DocumentChange is for an updated document.
- getDocument(GetDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Gets a single document.
- getDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Gets a single document.
- getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- getDocumentChanges() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the list of documents that changed since the last snapshot.
- getDocumentReference() - Method in exception com.google.cloud.firestore.BulkWriterException
- getDocuments() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the documents in this QuerySnapshot as a List in order of the query.
- getDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to getDocument.
- getDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to getDocument.
- getDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to getDocument.
- getDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to getDocument.
- getDouble(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the result of the given aggregation as a double.
- getDouble(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a double.
- getDouble(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a double.
- getEmulatorHost() - Method in class com.google.cloud.firestore.FirestoreOptions
- getEndBefore() - Method in class com.google.cloud.firestore.QueryPartition
-
The cursor that defines the first result after this partition.
- getExecutionDuration() - Method in class com.google.cloud.firestore.ExecutionStats
-
Returns the total execution time of the query.
- getExecutionStats() - Method in class com.google.cloud.firestore.ExplainMetrics
-
Returns the information about the execution of the query, or null if the query was not executed.
- getExecutionTime() - Method in class com.google.cloud.firestore.Pipeline.Snapshot
-
The time at which the pipeline producing this result is executed.
- getExecutionTime() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the time at which the pipeline producing this result is executed.
- getExecutor() - Method in class com.google.cloud.firestore.BulkWriterOptions
- getExecutor() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Returns the executor used by the GAPIC client.
- getExecutor() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- getExecutor() - Method in class com.google.cloud.firestore.TransactionOptions.Builder
- getExecutor() - Method in class com.google.cloud.firestore.TransactionOptions
- getExplainStats() - Method in class com.google.cloud.firestore.Pipeline.Snapshot
-
Return stats from query explain.
- getExpr() - Method in class com.google.cloud.firestore.pipeline.expressions.AliasedAggregate
- getExpr() - Method in class com.google.cloud.firestore.pipeline.expressions.AliasedExpression
- getExpr() - Method in class com.google.cloud.firestore.pipeline.expressions.Ordering
- getFailedAttempts() - Method in exception com.google.cloud.firestore.BulkWriterException
- getFirestore() - Method in class com.google.cloud.firestore.DocumentReference
- getFirestore() - Method in class com.google.cloud.firestore.StreamableQuery
-
Gets the Firestore instance associated with this query.
- getGeoPoint(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a GeoPoint.
- getGeoPoint(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a GeoPoint.
- getId() - Method in class com.google.cloud.firestore.CollectionReference
-
The id of a collection refers to the last component of path pointing to a collection, for example "collection-id" in "projects/project-id/databases/database-id/documents/collection-id".
- getId() - Method in class com.google.cloud.firestore.DocumentReference
-
The id of a document refers to the last component of path pointing to a document, for example "document-id" in "projects/project-id/databases/database-id/document-id".
- getId() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the ID of the document contained in this snapshot.
- getId() - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
-
Returns the ID for this bundle.
- getId() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the ID of the document represented by this result.
- getIndexesUsed() - Method in class com.google.cloud.firestore.PlanSummary
- getInitialOpsPerSecond() - Method in class com.google.cloud.firestore.BulkWriterOptions
-
Returns the initial maximum number of operations per second allowed by the throttler.
- getInstance() - Static method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getInstance(FirestoreOptions) - Static method in interface com.google.cloud.firestore.telemetry.MetricsUtil
-
Creates an instance of
MetricsUtil. - getInstance(FirestoreOptions) - Static method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Creates and returns an instance of the TraceUtil class.
- getKey() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getKey() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getKey() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getLatitude() - Method in class com.google.cloud.firestore.GeoPoint
-
Returns the latitude.
- getLeft() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getLeft() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getLeft() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getLibraryMetadata() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
- getLong(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the result of the given aggregation as a long.
- getLong(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a long.
- getLong(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a long.
- getLongitude() - Method in class com.google.cloud.firestore.GeoPoint
-
Returns the longitude.
- getMax() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getMax() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getMax() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getMaxEntry() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- getMaxKey() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- getMaxKey() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- getMaxKey() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getMaxOpsPerSecond() - Method in class com.google.cloud.firestore.BulkWriterOptions
-
Returns the maximum number of operations per second allowed by the throttler.
- getMessage() - Method in exception com.google.cloud.firestore.BulkWriterException
- getMethodDescriptors() - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- getMetrics() - Method in class com.google.cloud.firestore.ExplainResults
-
Returns the information about planning and execution (if any) of the query.
- getMin() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getMin() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getMin() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getMinEntry() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- getMinKey() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- getMinKey() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- getMinKey() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getMutationsSize() - Method in class com.google.cloud.firestore.UpdateBuilder
-
Get the number of writes.
- getNewIndex() - Method in class com.google.cloud.firestore.DocumentChange
-
The index of the changed document in the result set immediately after this DocumentChange (specifically, supposing that all prior DocumentChange objects and the current DocumentChange object have been applied).
- getNumberOfAttempts() - Method in class com.google.cloud.firestore.TransactionOptions
-
Returns the maximum number of times a transaction will be attempted before resulting in an error.
- getNumberOfAttempts() - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder
-
Specify the max number of attempts a transaction will be attempted before resulting in an error.
- getOldIndex() - Method in class com.google.cloud.firestore.DocumentChange
-
The index of the changed document in the result set immediately prior to this DocumentChange (specifically, supposing that all prior DocumentChange objects have been applied).
- getOpenTelemetry() - Method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions
- getOpenTelemetry() - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- getOpenTelemetryOptions() - Method in class com.google.cloud.firestore.FirestoreOptions
- getOperationsStub() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- getOperationType() - Method in exception com.google.cloud.firestore.BulkWriterException
- getOperator() - Method in class com.google.cloud.firestore.AggregateField.AverageAggregateField
- getOperator() - Method in class com.google.cloud.firestore.AggregateField.CountAggregateField
- getOperator() - Method in class com.google.cloud.firestore.AggregateField.SumAggregateField
- getParent() - Method in class com.google.cloud.firestore.CollectionReference
-
Returns a DocumentReference to the containing Document if this is a subcollection, else null.
- getParent() - Method in class com.google.cloud.firestore.DocumentReference
-
A reference to the Collection to which this DocumentReference belongs to.
- getPartitions(long) - Method in class com.google.cloud.firestore.CollectionGroup
- getPartitions(long, ApiStreamObserver<QueryPartition>) - Method in class com.google.cloud.firestore.CollectionGroup
-
Deprecated.Please use
CollectionGroup.getPartitions(long)instead. All cursors will be loaded before any value will be provided toobserver. - getPath() - Method in class com.google.cloud.firestore.CollectionReference
-
A string representing the path of the referenced collection (relative to the root of the database).
- getPath() - Method in class com.google.cloud.firestore.DocumentReference
-
A string representing the path of the referenced document (relative to the root of the database).
- getPath() - Method in class com.google.cloud.firestore.pipeline.expressions.Field
- getPlanSummary() - Method in class com.google.cloud.firestore.ExplainMetrics
-
Returns the information about the query plan.
- getPredecessorEntry(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getQuery() - Method in class com.google.cloud.firestore.AggregateQuery
-
Returns the query whose aggregations will be calculated by this object.
- getQuery() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the query that was executed to produce this result.
- getQuery() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the query for the snapshot.
- getRawData() - Method in class com.google.cloud.firestore.ExplainStats
-
Returns the explain stats in an encoded proto format, as returned from the Firestore backend.
- getReadOperations() - Method in class com.google.cloud.firestore.ExecutionStats
-
Returns the number of read operations that occurred when executing the query.
- getReadTime() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Returns the time at which this snapshot was read.
- getReadTime() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the time at which this snapshot was read.
- getReadTime() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the time at which this snapshot was read.
- getReadTime() - Method in class com.google.cloud.firestore.TransactionOptions
-
A
Timestampspecifying the time documents are to be read at. - getReadTime() - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder
- getReference() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Gets the reference to the document.
- getReference() - Method in class com.google.cloud.firestore.PipelineResult
-
Gets the reference to the document.
- getRequestMetadata(URI) - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- getResults() - Method in class com.google.cloud.firestore.Pipeline.Snapshot
-
An array of all the results in the `Snapshot`.
- getResultsReturned() - Method in class com.google.cloud.firestore.ExecutionStats
-
Returns the number of query results.
- getRight() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getRight() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getRight() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getScopes() - Method in class com.google.cloud.firestore.FirestoreOptions
- getServiceName() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the default service name.
- getSettings() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- getSnapshot() - Method in class com.google.cloud.firestore.ExplainResults
-
Returns the snapshot that contains the results of executing the query, or null if the query was not executed.
- getStartAt() - Method in class com.google.cloud.firestore.QueryPartition
-
The cursor that defines the first result for this partition.
- getStatus() - Method in exception com.google.cloud.firestore.BulkWriterException
- getStatus() - Method in exception com.google.cloud.firestore.FirestoreException
- getString(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a String.
- getString(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a String.
- getStub() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- getStubSettingsBuilder() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
- getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- getText() - Method in class com.google.cloud.firestore.ExplainStats
-
When explain stats were requested with `outputFormat = 'text'`, this returns the explain stats string verbatim as returned from the Firestore backend.
- getThrottlingEnabled() - Method in class com.google.cloud.firestore.BulkWriterOptions
-
Return whether throttling is enabled.
- getTimestamp(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a
Timestamp. - getTimestamp(String) - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the value of the field as a
Timestamp. - getTransportChannelProvider() - Method in class com.google.cloud.firestore.FirestoreOptions
- getType() - Method in class com.google.cloud.firestore.DocumentChange
- getType() - Method in class com.google.cloud.firestore.TransactionOptions
-
A type flag indicating the type of transaction represented.
- getUpdateTime() - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the time at which this document was last updated.
- getUpdateTime() - Method in class com.google.cloud.firestore.PipelineResult
-
Returns the time at which this document was last updated.
- getUpdateTime() - Method in class com.google.cloud.firestore.WriteResult
-
The update time as exposed by the server.
- getValue() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- getValue() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- getValue() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- getVectorValue(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the value of the field as a VectorValue.
- greaterThan(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is greater than the given value.
- greaterThan(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the first expression is greater than the second expression.
- greaterThan(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is greater than a constant value.
- greaterThan(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is greater than a
value. - greaterThan(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is greater than an expression.
- greaterThan(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is greater than the given value.
- greaterThan(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is greater than a constant value.
- greaterThanOrEqual(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the first expression is greater than or equal to the second expression.
- greaterThanOrEqual(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is greater than or equal to a constant value.
- greaterThanOrEqual(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is greater than or equal to a
value. - greaterThanOrEqual(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is greater than or equal to an expression.
- greaterThanOrEqual(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is greater than or equal to a constant value.
- greaterThanOrEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is greater than or equal to the given value.
- greaterThanOrEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is greater than or equal to the given value.
- GrpcFirestoreCallableFactory - Class in com.google.cloud.firestore.v1.stub
-
gRPC callable factory implementation for the Firestore service API.
- GrpcFirestoreCallableFactory() - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory
- GrpcFirestoreRpc - Class in com.google.cloud.firestore.spi.v1
-
GRPC client implementation of the Firestore RPC methods.
- GrpcFirestoreRpc(FirestoreOptions) - Constructor for class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- GrpcFirestoreStub - Class in com.google.cloud.firestore.v1.stub
-
gRPC stub implementation for the Firestore service API.
- GrpcFirestoreStub(FirestoreStubSettings, ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
-
Constructs an instance of GrpcFirestoreStub, using the given settings.
- GrpcFirestoreStub(FirestoreStubSettings, ClientContext, GrpcStubCallableFactory) - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
-
Constructs an instance of GrpcFirestoreStub, using the given settings.
H
- hashCode() - Method in class com.google.cloud.firestore.AggregateField
-
Calculates and returns the hash code for this object.
- hashCode() - Method in class com.google.cloud.firestore.AggregateQuery
-
Calculates and returns the hash code for this object.
- hashCode() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot
-
Calculates and returns the hash code for this object.
- hashCode() - Method in class com.google.cloud.firestore.Blob
- hashCode() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- hashCode() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- hashCode() - Method in class com.google.cloud.firestore.DocumentChange
- hashCode() - Method in class com.google.cloud.firestore.DocumentReference
- hashCode() - Method in class com.google.cloud.firestore.DocumentSnapshot
- hashCode() - Method in class com.google.cloud.firestore.FieldValue
- hashCode() - Method in class com.google.cloud.firestore.FirestoreOptions
- hashCode() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
- hashCode() - Method in class com.google.cloud.firestore.GeoPoint
- hashCode() - Method in class com.google.cloud.firestore.pipeline.expressions.Field
- hashCode() - Method in class com.google.cloud.firestore.pipeline.expressions.FunctionExpression
- hashCode() - Method in class com.google.cloud.firestore.PipelineResult
- hashCode() - Method in class com.google.cloud.firestore.Precondition
- hashCode() - Method in class com.google.cloud.firestore.Query
- hashCode() - Method in class com.google.cloud.firestore.QueryPartition
- hashCode() - Method in class com.google.cloud.firestore.SetOptions
- hashCode() - Method in class com.google.cloud.firestore.VectorQuery
- hashCode() - Method in class com.google.cloud.firestore.VectorValue
- hashCode() - Method in class com.google.cloud.firestore.WriteResult
- hasNext() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator
- hasRequestMetadata() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- hasRequestMetadataOnly() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- hasTransactionId() - Method in class com.google.cloud.firestore.Transaction
- HttpJsonFirestoreCallableFactory - Class in com.google.cloud.firestore.v1.stub
-
REST callable factory implementation for the Firestore service API.
- HttpJsonFirestoreCallableFactory() - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory
- HttpJsonFirestoreStub - Class in com.google.cloud.firestore.v1.stub
-
REST stub implementation for the Firestore service API.
- HttpJsonFirestoreStub(FirestoreStubSettings, ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
-
Constructs an instance of HttpJsonFirestoreStub, using the given settings.
- HttpJsonFirestoreStub(FirestoreStubSettings, ClientContext, HttpJsonStubCallableFactory) - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
-
Constructs an instance of HttpJsonFirestoreStub, using the given settings.
I
- identityTranslator() - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
- ifAbsent(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a default value if an expression evaluates to an absent value.
- ifAbsent(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a default value if an expression evaluates to an absent value.
- ifAbsent(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a default value if this expression evaluates to an absent value.
- ifAbsent(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a default value if a field is absent.
- ifAbsent(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a default value if a field is absent.
- ifError(BooleanExpression) - Method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates an expression that returns the
catchExprargument if there is an error, else return the result of this expression. - ifError(BooleanExpression, BooleanExpression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
catchExprargument if there is an error, else return the result of thetryExprargument evaluation. - ifError(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
catchExprargument if there is an error, else return the result of this expression. - ifError(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
catchExprargument if there is an error, else return the result of thetryExprargument evaluation. - ifError(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
catchValueargument if there is an error, else return the result of thetryExprargument evaluation. - ifError(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
catchValueargument if there is an error, else return the result of this expression. - IgnoreExtraProperties - Annotation Type in com.google.cloud.firestore.annotation
-
Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation.
- ImmutableSortedMap<K,
V> - Class in com.google.cloud.firestore.collection - ImmutableSortedMap() - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedMap
- ImmutableSortedMap.Builder - Class in com.google.cloud.firestore.collection
- ImmutableSortedMap.Builder.KeyTranslator<C,
D> - Interface in com.google.cloud.firestore.collection - ImmutableSortedMapIterator<K,
V> - Class in com.google.cloud.firestore.collection - ImmutableSortedSet<T> - Class in com.google.cloud.firestore.collection
- ImmutableSortedSet(List<T>, Comparator<T>) - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedSet
- inArray(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field equals any of the given values.
- inArray(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field equals any of the given values.
- increment(double) - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a special value that can be used with set(), create() or update() that tells the server to increment the field's current value by the given value.
- increment(long) - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a special value that can be used with set(), create() or update() that tells the server to increment the field's current value by the given value.
- incrementCounter() - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext
-
Increments the counter tracked inside the MetricsContext.
- indexOf(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- indexOf(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- indexOf(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- indexOf(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- insert(K, V) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- insert(K, V) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- insert(K, V) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- insert(K, V, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- insert(K, V, Comparator<K>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- insert(K, V, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- insert(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- Internal - Class in com.google.cloud.firestore
- Internal(FirestoreImpl) - Constructor for class com.google.cloud.firestore.Internal
- Internal(FirestoreOptions, FirestoreRpc) - Constructor for class com.google.cloud.firestore.Internal
- isAbsent() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns true if yhe result of this expression is absent.
- isAbsent(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns true if a value is absent.
- isAbsent(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns true if a field is absent.
- isAlwaysUseImplicitOrderBy() - Method in class com.google.cloud.firestore.FirestoreOptions
- isEmpty() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- isEmpty() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- isEmpty() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- isEmpty() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- isEmpty() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- isEmpty() - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- isEmpty() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- isEmpty() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns true if there are no documents in the QuerySnapshot.
- isError() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression produces an error.
- isError(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a given expression produces an error.
- isNaN() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression evaluates to 'NaN' (Not a Number).
- isNotNaN() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the results of this expression is NOT 'NaN' (Not a Number).
- isNotNaN(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the results of
expris NOT 'NaN' (Not a Number). - isNotNaN(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the results of this expression is NOT 'NaN' (Not a Number).
- isNotNull() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if tbe result of this expression is not null.
- isNull() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if tbe result of this expression is null.
- isRed() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode
- isRed() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- isRed() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- isRed() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode
- isShutdown() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- isShutdown() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- isShutdown() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- isTerminated() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- isTerminated() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- isTerminated() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- iterator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- iterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- iterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- iterator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- iterator() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
- iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- iteratorFrom(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
J
- join(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of this array expression into a string.
- join(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of an array into a string.
- join(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of an array into a string.
- join(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of this array expression into a string.
- join(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of an array into a string.
- join(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that joins the elements of an array into a string.
L
- last() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that finds the last value of this expression across multiple stage inputs.
- last(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the last value of an expression across multiple stage inputs.
- last(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the last value of a field across multiple stage inputs.
- length() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of the expression if it is a string, array, map, or Blob.
- length(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of string, array, map, vector, or Blob.
- length(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of string, array, map, vector, or Blob.
- lessThan(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is less than the given value.
- lessThan(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the first expression is less than the second expression.
- lessThan(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is less than a constant value.
- lessThan(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is less than a value.
- lessThan(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is less than an expression.
- lessThan(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is less than the given value.
- lessThan(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is less than a constant value.
- lessThanOrEqual(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if the first expression is less than or equal to the second expression.
- lessThanOrEqual(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is less than or equal to a constant value.
- lessThanOrEqual(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is less than or equal to a
value. - lessThanOrEqual(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is less than or equal to an expression.
- lessThanOrEqual(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is less than or equal to a constant value.
- lessThanOrEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is less than or equal to the given value.
- lessThanOrEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is less than or equal to the given value.
- LIBRARY_NAME - Static variable in interface com.google.cloud.firestore.telemetry.TraceUtil
- like(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a case-sensitive wildcard string comparison.
- like(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a case-sensitive wildcard string comparison.
- like(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a case-sensitive wildcard string comparison.
- like(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a case-sensitive wildcard string comparison against a field.
- like(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a case-sensitive wildcard string comparison against a field.
- limit(int) - Method in class com.google.cloud.firestore.Pipeline
-
Limits the maximum number of documents returned by previous stages to `limit`.
- limit(int) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that only returns the first matching documents.
- Limit - Class in com.google.cloud.firestore.pipeline.stages
- Limit(int) - Constructor for class com.google.cloud.firestore.pipeline.stages.Limit
- limitToLast(int) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that only returns the last matching documents.
- listCollectionIds(ListCollectionIdsRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists all the collection IDs underneath a document.
- listCollectionIds(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists all the collection IDs underneath a document.
- listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists all the collection IDs underneath a document.
- listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- listCollectionIdsPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Returns a list of collections IDs.
- listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists all the collection IDs underneath a document.
- listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to listCollectionIds.
- listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to listCollectionIds.
- listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to listCollectionIds.
- listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to listCollectionIds.
- listCollections() - Method in class com.google.cloud.firestore.DocumentReference
-
Fetches the subcollections that are direct children of this document.
- listCollections() - Method in interface com.google.cloud.firestore.Firestore
-
Fetches the root collections that are associated with this Firestore database.
- listDocuments() - Method in class com.google.cloud.firestore.CollectionReference
-
Retrieves the list of documents in this collection.
- listDocuments(ListDocumentsRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists documents.
- listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists documents.
- listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- listDocumentsPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Returns a list of documents.
- listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists documents.
- listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to listDocuments.
- listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to listDocuments.
- listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to listDocuments.
- listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to listDocuments.
- listenCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Returns a bi-directional watch stream.
- listenCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- listenCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Listens to changes.
- listenCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- listenCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- listenCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- ListenerRegistration - Interface in com.google.cloud.firestore
-
Represents a listener that can be removed by calling remove().
- listenSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to listen.
- listenSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to listen.
- listenSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to listen.
- listenSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to listen.
- LLRBBlackValueNode<K,
V> - Class in com.google.cloud.firestore.collection - LLRBEmptyNode<K,
V> - Class in com.google.cloud.firestore.collection - LLRBNode<K,
V> - Interface in com.google.cloud.firestore.collection - LLRBNode.Color - Enum in com.google.cloud.firestore.collection
- LLRBNode.NodeVisitor<K,
V> - Class in com.google.cloud.firestore.collection - LLRBNode.ShortCircuitingNodeVisitor<K,
V> - Interface in com.google.cloud.firestore.collection - LLRBRedValueNode<K,
V> - Class in com.google.cloud.firestore.collection - LLRBValueNode<K,
V> - Class in com.google.cloud.firestore.collection - ln() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the natural logarithm (base e) of this numeric expression.
- ln(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the natural logarithm (base e) of
numericExpr. - ln(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the natural logarithm (base e) of
numericField. - log(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the logarithm of
numericExprwith a givenbase. - log(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the logarithm of
numericExprwith a givenbase. - log(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the logarithm of
numericFieldwith a givenbase. - log(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the logarithm of
numericFieldwith a givenbase. - log10() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the base 10 logarithm of this numeric expression.
- log10(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the base 10 logarithm of
numericExpr. - log10(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the base 10 logarithm of
numericField. - logger - Static variable in interface com.google.cloud.firestore.telemetry.MetricsUtil
- logicalMaximum(Expression, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest value between multiple input expressions or literal values.
- logicalMaximum(Object...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest value between multiple input expressions or literal values.
- logicalMaximum(String, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the largest value between multiple input expressions or literal values.
- logicalMinimum(Expression, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest value between multiple input expressions or literal values.
- logicalMinimum(Object...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest value between multiple input expressions or literal values.
- logicalMinimum(String, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the smallest value between multiple input expressions or literal values.
M
- makeCurrent() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Context
-
Makes this context the current context.
- makeCurrent() - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Marks this span as the current span.
- map(Map<String, Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that creates a Firestore map value from an input object.
- mapGet(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Accesses a value from a map (object) field using the provided
keyExpression. - mapGet(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Accesses a value from a map (object) field using the provided
key. - mapGet(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Accesses a map (object) value using the provided
key. - mapGet(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Accesses a value from a map (object) field using the provided
keyExpression. - mapGet(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Accesses a value from a map (object) field using the provided
key. - mapMerge(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
- mapMerge(Expression, Expression...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that merges multiple maps into a single map.
- mapMerge(Expression, Expression, Expression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that merges multiple maps into a single map.
- mapMerge(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
- mapMerge(String, Expression, Expression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that merges multiple maps into a single map.
- mapRemove(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from this map expression.
- mapRemove(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from a map.
- mapRemove(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from a map.
- mapRemove(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from this map expression.
- mapRemove(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from a map.
- mapRemove(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes a key from a map.
- MAX_BATCH_SIZE - Static variable in class com.google.cloud.firestore.BulkWriter
-
The maximum number of writes that can be in a single batch.
- MAX_PENDING_OPS - Static variable in class com.google.cloud.firestore.RecursiveDelete
-
The query limit used for recursive deletes when fetching all descendants of the specified reference to delete.
- MAX_RETRY_ATTEMPTS - Static variable in class com.google.cloud.firestore.BulkWriter
-
The maximum number of retries that will be attempted with backoff before stopping all retry attempts.
- maximum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that finds the maximum value of this expression across multiple stage inputs.
- maximum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the maximum value of an expression across multiple stage inputs.
- maximum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the maximum value of a field across multiple stage inputs.
- merge() - Static method in class com.google.cloud.firestore.SetOptions
-
Changes the behavior of set() calls to only replace the values specified in its data argument.
- MERGE_PREFER_NEXT - Enum constant in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
- MERGE_PREFER_PARENT - Enum constant in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
- mergeFieldPaths(List<FieldPath>) - Static method in class com.google.cloud.firestore.SetOptions
-
Changes the behavior of set() calls to only replace the fields under fieldPaths.
- mergeFields(String...) - Static method in class com.google.cloud.firestore.SetOptions
-
Changes the behavior of set() calls to only replace the fields under fieldPaths.
- mergeFields(List<String>) - Static method in class com.google.cloud.firestore.SetOptions
-
Changes the behavior of set() calls to only replace the fields under fieldPaths.
- METHOD_NAME_AGGREGATION_QUERY_GET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_BATCH_COMMIT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_BATCH_GET_DOCUMENTS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_BATCH_GET_DOCUMENTS_GET_ALL - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_BATCH_GET_DOCUMENTS_TRANSACTIONAL - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_BULK_WRITER_COMMIT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_COL_REF_ADD - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_COL_REF_LIST_DOCUMENTS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_CREATE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_DELETE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_GET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_LIST_COLLECTIONS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_SET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_DOC_REF_UPDATE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_EXECUTE_PIPELINE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_EXECUTE_PIPELINE_EXECUTE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_PARTITION_QUERY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_PIPELINE_EXECUTE - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_QUERY_GET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_AGGREGATION_QUERY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_AGGREGATION_QUERY_EXPLAIN - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_AGGREGATION_QUERY_GET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_AGGREGATION_QUERY_TRANSACTIONAL - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_QUERY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_QUERY_EXPLAIN - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_QUERY_GET - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_QUERY_TRANSACTIONAL - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_RUN_TRANSACTION - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_BEGIN - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_COMMIT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_GET_AGGREGATION_QUERY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_GET_DOCUMENT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_GET_DOCUMENTS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_GET_QUERY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_ROLLBACK - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METHOD_NAME_TRANSACTION_RUN - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_ATTRIBUTE_KEY_CLIENT_UID - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_ATTRIBUTE_KEY_LIBRARY_NAME - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_ATTRIBUTE_KEY_LIBRARY_VERSION - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_ATTRIBUTE_KEY_METHOD - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_ATTRIBUTE_KEY_STATUS - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_ATTEMPT_COUNT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_ATTEMPT_LATENCY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_END_TO_END_LATENCY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_FIRST_RESPONSE_LATENCY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_OPERATION_COUNT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_OPERATION_LATENCY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_TRANSACTION_ATTEMPT_COUNT - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_NAME_TRANSACTION_LATENCY - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- METRIC_PREFIX - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- MetricsUtil - Interface in com.google.cloud.firestore.telemetry
-
A utility interface for metrics collection.
- MetricsUtil.MetricsContext - Interface in com.google.cloud.firestore.telemetry
-
A context for recording metrics in the Firestore SDK.
- MIN_PENDING_OPS - Static variable in class com.google.cloud.firestore.RecursiveDelete
-
The number of pending BulkWriter operations at which RecursiveDelete starts the next limit query to fetch descendants.
- minimum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that finds the minimum value of this expression across multiple stage inputs.
- minimum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the minimum value of an expression across multiple stage inputs.
- minimum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that finds the minimum value of a field across multiple stage inputs.
- mod(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the modulo (remainder) of dividing two numeric expressions.
- mod(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the modulo (remainder) of dividing a numeric expression by a constant.
- mod(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the modulo (remainder) of dividing this numeric expressions by another numeric expression.
- mod(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.
- mod(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the modulo (remainder) of dividing a numeric field by a constant.
- MODIFIED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type
-
Indicates a document within the query was modified.
- multiply(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that multiplies numeric expressions.
- multiply(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that multiplies numeric expressions with a constant.
- multiply(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that multiplies this numeric expression with another numeric expression.
- multiply(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that multiplies a numeric field with a numeric expression.
- multiply(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that multiplies a numeric field with a constant.
N
- name - Variable in class com.google.cloud.firestore.pipeline.stages.Stage
- newBuilder() - Static method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions
- newBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions
- newBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a new gRPC builder for this class.
- newBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a new gRPC builder for this class.
- newBuilder() - Static method in class com.google.cloud.firestore.VectorQueryOptions
- newBuilder(ClientContext) - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a new builder for this class.
- newBuilder(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a new builder for this class.
- newHttpJsonBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a new REST builder for this class.
- newHttpJsonBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a new REST builder for this class.
- newTracer(ApiTracer, SpanName, ApiTracerFactory.OperationType) - Method in class com.google.cloud.firestore.telemetry.CompositeApiTracerFactory
- next() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator
- NodeVisitor() - Constructor for class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor
- NONE - Static variable in class com.google.cloud.firestore.Precondition
-
An empty Precondition that adds no enforcements
- not() - Method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates an expression that negates this boolean expression.
- not(BooleanExpression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that negates a boolean expression.
- notEqual(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if two expressions are not equal.
- notEqual(Expression, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an expression is not equal to a constant value.
- notEqual(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression is not equal to a
value. - notEqual(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is not equal to an expression.
- notEqual(String, Object) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field is not equal to a constant value.
- notEqualAny(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an
expression, when evaluated, is not equal to all the elements ofarrayExpression. - notEqualAny(Expression, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if an
expression, when evaluated, is not equal to all the providedvalues. - notEqualAny(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field's value is not equal to all of the elements of
arrayExpression. - notEqualAny(String, List<Object>) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a field's value is not equal to all of the provided
values. - notEqualAny(List<Object>) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this expression, when evaluated, is not equal to all the provided
values. - notEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is not equal to the given value.
- notEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field is not equal to the given value.
- notInArray(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field does not equal any of the given values.
- notInArray(String, Object) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter for checking that the given field does not equal any of the given values.
- nullValue() - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Constant for a null value.
O
- of(DocumentReference...) - Static method in class com.google.cloud.firestore.pipeline.stages.Documents
- of(FieldPath...) - Static method in class com.google.cloud.firestore.FieldMask
-
Creates a FieldMask from the provided field paths.
- of(String...) - Static method in class com.google.cloud.firestore.FieldMask
-
Creates a FieldMask from the provided field paths.
- of(String...) - Static method in class com.google.cloud.firestore.FieldPath
-
Creates a FieldPath from the provided field names.
- of(String, boolean) - Static method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- of(String, double) - Static method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- of(String, long) - Static method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- of(String, Field) - Static method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- of(String, String) - Static method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- offset(int) - Method in class com.google.cloud.firestore.Pipeline
-
Skips the first `offset` number of documents from the results of previous stages.
- offset(int) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that skips the first n results.
- Offset - Class in com.google.cloud.firestore.pipeline.stages
- Offset(int) - Constructor for class com.google.cloud.firestore.pipeline.stages.Offset
- ofName(String) - Static method in class com.google.cloud.firestore.pipeline.stages.RawStage
-
Specify name of stage
- ofServerPath(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Field
- ofUserPath(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Field
-
Creates a
Fieldinstance representing the field at the given path. - onError(BulkWriterException) - Method in interface com.google.cloud.firestore.BulkWriter.WriteErrorCallback
- onEvent(T, FirestoreException) - Method in interface com.google.cloud.firestore.EventListener
-
onEvent will be called with the new value or the error if an error occurred.
- onResult(DocumentReference, WriteResult) - Method in interface com.google.cloud.firestore.BulkWriter.WriteResultCallback
- OpenTelemetryGrpcChannelConfigurator() - Constructor for class com.google.cloud.firestore.telemetry.EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator
- options - Variable in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- or(Filter...) - Static method in class com.google.cloud.firestore.Filter
-
Creates a new filter that is a disjunction of the given filters.
- or(BooleanExpression, BooleanExpression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a logical 'OR' operation.
- orderBy(FieldPath) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that's additionally sorted by the specified field.
- orderBy(FieldPath, Query.Direction) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.
- orderBy(String) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that's additionally sorted by the specified field.
- orderBy(String, Query.Direction) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.
- Ordering - Class in com.google.cloud.firestore.pipeline.expressions
- Ordering.Direction - Enum in com.google.cloud.firestore.pipeline.expressions
P
- partitionQuery(PartitionQueryRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Partitions a query by returning partition cursors that can be used to run the query in parallel.
- partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Partitions a query by returning partition cursors that can be used to run the query in parallel.
- partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- partitionQueryPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
- partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Partitions a query by returning partition cursors that can be used to run the query in parallel.
- partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to partitionQuery.
- partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to partitionQuery.
- partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to partitionQuery.
- partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to partitionQuery.
- PERCENT - Enum constant in enum com.google.cloud.firestore.pipeline.stages.Sample.Mode
- pipeline() - Method in interface com.google.cloud.firestore.Firestore
-
Creates a new
PipelineSourceto build and execute a data pipeline. - Pipeline - Class in com.google.cloud.firestore
-
The Pipeline class provides a flexible and expressive framework for building complex data transformation and query pipelines for Firestore.
- Pipeline.Snapshot - Class in com.google.cloud.firestore
-
A Snapshot contains the results of a pipeline execution.
- PipelineExecuteOptions - Class in com.google.cloud.firestore.pipeline.stages
- PipelineExecuteOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.PipelineExecuteOptions
- PipelineResult - Class in com.google.cloud.firestore
-
A PipelineResult contains data read from a Firestore Pipeline.
- PipelineSource - Class in com.google.cloud.firestore
-
A factory for creating
Pipelineinstances, which provide a framework for building data transformation and query pipelines for Firestore. - PipelineUtils - Class in com.google.cloud.firestore
- PipelineUtils() - Constructor for class com.google.cloud.firestore.PipelineUtils
- PlanSummary - Class in com.google.cloud.firestore
-
A Plan contains information about the planning stage of a query.
- pow(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns this numeric expression raised to the power of the
exponent. - pow(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
numericExprraised to the power of theexponent. - pow(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
numericExprraised to the power of theexponent. - pow(Number) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns this numeric expression raised to the power of the
exponent. - pow(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
numericFieldraised to the power of theexponent. - pow(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the
numericFieldraised to the power of theexponent. - Precondition - Class in com.google.cloud.firestore
-
Preconditions that can be used to restrict update() calls.
- projectIdRequired() - Method in class com.google.cloud.firestore.FirestoreOptions
- PropertyName - Annotation Type in com.google.cloud.firestore.annotation
-
Marks a field to be renamed when serialized.
- protoFromSnapshot(DocumentSnapshot) - Method in class com.google.cloud.firestore.Internal
Q
- query - Variable in class com.google.cloud.firestore.GenericQuerySnapshot
- Query - Class in com.google.cloud.firestore
-
A Query which you can read or listen to.
- Query(FirestoreRpcContext<?>, Query.QueryOptions) - Constructor for class com.google.cloud.firestore.Query
- Query.Direction - Enum in com.google.cloud.firestore
-
The direction of a sort.
- QueryDocumentSnapshot - Class in com.google.cloud.firestore
-
A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a query.
- QueryPartition - Class in com.google.cloud.firestore
-
A split point that can be used in a query as a starting and/or end point for the query results.
- QueryPartition(Query, Object[], Object[]) - Constructor for class com.google.cloud.firestore.QueryPartition
- QuerySnapshot - Class in com.google.cloud.firestore
-
A QuerySnapshot contains the results of a query.
- QuerySnapshot(Query, Timestamp) - Constructor for class com.google.cloud.firestore.QuerySnapshot
- QuerySnapshot(Query, Timestamp, List<QueryDocumentSnapshot>, List<DocumentChange>) - Constructor for class com.google.cloud.firestore.QuerySnapshot
R
- rand() - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a random double between 0.0 and 1.0 but not including 1.0.
- rawAggregate(String, Expression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates a raw aggregation function.
- rawExpression(String, Expression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates a generic function expression that is not yet implemented.
- rawFunction(String, Expression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.BooleanExpression
-
Creates a 'raw' boolean function expression.
- RawOptions - Class in com.google.cloud.firestore.pipeline.stages
- RawOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.RawOptions
- rawStage(RawStage) - Method in class com.google.cloud.firestore.Pipeline
-
Adds a generic stage to the pipeline.
- RawStage - Class in com.google.cloud.firestore.pipeline.stages
-
Adds a stage to the pipeline by specifying the stage name as an argument.
- RBTreeSortedMap<K,
V> - Class in com.google.cloud.firestore.collection -
This is a red-black tree backed implementation of ImmutableSortedMap.
- READ_ONLY - Enum constant in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType
- READ_WRITE - Enum constant in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType
- readTime - Variable in class com.google.cloud.firestore.GenericQuerySnapshot
- recordCounterAtFuture(TelemetryConstants.MetricType, ApiFuture<T>) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext
-
Records the counter value for a metric type _after_ the future has been completed.
- recordLatency(TelemetryConstants.MetricType) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext
-
Records specific type of latency for the current operation.
- recordLatency(TelemetryConstants.MetricType, Throwable) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext
-
Records specific type of latency for the current operation, which ended with a throwable.
- recordLatencyAtFuture(TelemetryConstants.MetricType, ApiFuture<T>) - Method in interface com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext
-
If the operation ends in the future, its relevant metrics should be recorded _after_ the future has been completed.
- recursiveDelete(CollectionReference) - Method in interface com.google.cloud.firestore.Firestore
-
Recursively deletes all documents and subcollections at and under the specified level.
- recursiveDelete(CollectionReference, BulkWriter) - Method in interface com.google.cloud.firestore.Firestore
-
Recursively deletes all documents and subcollections at and under the specified level.
- recursiveDelete(DocumentReference) - Method in interface com.google.cloud.firestore.Firestore
-
Recursively deletes all documents and subcollections at and under the specified level.
- recursiveDelete(DocumentReference, BulkWriter) - Method in interface com.google.cloud.firestore.Firestore
-
Recursively deletes all documents and subcollections at and under the specified level.
- RecursiveDelete - Class in com.google.cloud.firestore
-
Class used to store state required for running a recursive delete operation.
- RED - Enum constant in enum com.google.cloud.firestore.collection.LLRBNode.Color
- REFERENCE_NAME_MIN_ID - Static variable in class com.google.cloud.firestore.RecursiveDelete
-
Datastore allowed numeric IDs where Firestore only allows strings.
- refresh() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials
- regexContains(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression contains a specified regular expression as a substring.
- regexContains(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression contains a specified regular expression as a substring.
- regexContains(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this string expression contains a specified regular expression as a substring.
- regexContains(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field contains a specified regular expression as a substring.
- regexContains(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field contains a specified regular expression as a substring.
- regexFind(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
- regexFind(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
- regexFind(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first substring of a string expression that matches a specified regular expression.
- regexFind(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first substring of a string field that matches a specified regular expression.
- regexFind(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the first substring of a string field that matches a specified regular expression.
- regexFindAll(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
- regexFindAll(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
- regexFindAll(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that evaluates to a list of all substrings in a string expression that match a specified regular expression.
- regexFindAll(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that evaluates to a list of all substrings in a string field that match a specified regular expression.
- regexFindAll(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that evaluates to a list of all substrings in a string field that match a specified regular expression.
- regexMatch(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field matches a specified regular expression.
- regexMatch(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field matches a specified regular expression.
- regexMatch(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this string expression matches a specified regular expression.
- regexMatch(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field matches a specified regular expression.
- regexMatch(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field matches a specified regular expression.
- remove() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator
- remove() - Method in interface com.google.cloud.firestore.ListenerRegistration
-
Removes the listener being tracked by this ListenerRegistration.
- remove(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- remove(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- remove(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- remove(K, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- remove(K, Comparator<K>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- remove(K, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- remove(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- REMOVED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type
-
Indicates a document within the query was removed (either deleted or no longer matches the query.
- removeFields(Field, Field...) - Method in class com.google.cloud.firestore.Pipeline
-
Remove fields from outputs of previous stages.
- removeFields(String, String...) - Method in class com.google.cloud.firestore.Pipeline
-
Remove fields from outputs of previous stages.
- RemoveFields - Class in com.google.cloud.firestore.pipeline.stages
- RemoveFields(ImmutableList<Field>) - Constructor for class com.google.cloud.firestore.pipeline.stages.RemoveFields
- replaceWith(Expression) - Method in class com.google.cloud.firestore.Pipeline
-
Fully overwrites all fields in a document with those coming from a nested map.
- replaceWith(String) - Method in class com.google.cloud.firestore.Pipeline
-
Fully overwrites all fields in a document with those coming from a nested map.
- ReplaceWith - Class in com.google.cloud.firestore.pipeline.stages
- ReplaceWith(Expression) - Constructor for class com.google.cloud.firestore.pipeline.stages.ReplaceWith
- ReplaceWith(Expression, ReplaceWith.Mode) - Constructor for class com.google.cloud.firestore.pipeline.stages.ReplaceWith
- ReplaceWith.Mode - Enum in com.google.cloud.firestore.pipeline.stages
- RESOURCE_KEY_DATABASE_ID - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- RESOURCE_KEY_LOCATION - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- RESOURCE_KEY_RESOURCE_CONTAINER - Static variable in interface com.google.cloud.firestore.telemetry.TelemetryConstants
- RETRY_MAX_BATCH_SIZE - Static variable in class com.google.cloud.firestore.BulkWriter
-
The maximum number of writes that can be in a batch containing retries.
- reverse() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that reverses this expression, which must be a string, blob, or array.
- reverse(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that reverses a string, blob, or array.
- reverse(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that reverses the field value, which must be a string, blob, or array.
- reverseIterator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- reverseIterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- reverseIterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- reverseIterator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- reverseIteratorFrom(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- rollback(RollbackRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Rolls back a transaction.
- rollback(String, ByteString) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Rolls back a transaction.
- rollbackCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Rolls back a transaction.
- rollbackCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- rollbackCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Rolls back a transaction.
- rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- rollbackSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to rollback.
- rollbackSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to rollback.
- rollbackSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to rollback.
- rollbackSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to rollback.
- round() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds this numeric expression to nearest integer.
- round(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds
numericExprto nearest integer. - round(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds
numericFieldto nearest integer. - roundToPrecision(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off this numeric expression to
decimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - roundToPrecision(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off this numeric expression to
decimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - roundToPrecision(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off
numericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - roundToPrecision(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off
numericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - roundToPrecision(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off
numericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - roundToPrecision(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that rounds off
numericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, rounds off digits to the left of the decimal point ifdecimalPlaceis negative. - run() - Method in class com.google.cloud.firestore.RecursiveDelete
- runAggregationQueryCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Runs an aggregation query.
- runAggregationQueryCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Runs an aggregation query.
- runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to runAggregationQuery.
- runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to runAggregationQuery.
- runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to runAggregationQuery.
- runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to runAggregationQuery.
- runAsyncTransaction(Transaction.AsyncFunction<T>) - Method in interface com.google.cloud.firestore.Firestore
-
Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
- runAsyncTransaction(Transaction.AsyncFunction<T>, TransactionOptions) - Method in interface com.google.cloud.firestore.Firestore
-
Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
- runQueryCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
-
Runs a query.
- runQueryCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- runQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Runs a query.
- runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- runQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to runQuery.
- runQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to runQuery.
- runQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to runQuery.
- runQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to runQuery.
- runTransaction(Transaction.Function<T>) - Method in interface com.google.cloud.firestore.Firestore
-
Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
- runTransaction(Transaction.Function<T>, TransactionOptions) - Method in interface com.google.cloud.firestore.Firestore
-
Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
S
- sample(int) - Method in class com.google.cloud.firestore.Pipeline
-
Performs a pseudo-random sampling of the documents from the previous stage.
- sample(Sample) - Method in class com.google.cloud.firestore.Pipeline
-
Performs a pseudo-random sampling of the documents from the previous stage.
- Sample - Class in com.google.cloud.firestore.pipeline.stages
- Sample.Mode - Enum in com.google.cloud.firestore.pipeline.stages
- SampleOptions - Class in com.google.cloud.firestore.pipeline.stages
- SampleOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.SampleOptions
- select(FieldPath...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields.
- select(Selectable, Selectable...) - Method in class com.google.cloud.firestore.Pipeline
-
Selects or creates a set of fields from the outputs of previous stages.
- select(String...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields.
- select(String, String...) - Method in class com.google.cloud.firestore.Pipeline
-
Selects a set of fields from the outputs of previous stages.
- Select - Class in com.google.cloud.firestore.pipeline.stages
- Select(Map<String, Expression>) - Constructor for class com.google.cloud.firestore.pipeline.stages.Select
- Selectable - Interface in com.google.cloud.firestore.pipeline.expressions
- selectablesToMap(Selectable...) - Static method in class com.google.cloud.firestore.PipelineUtils
- self(InternalOptions) - Method in class com.google.cloud.firestore.pipeline.stages.RawOptions
- serialize(T) - Static method in class com.google.cloud.firestore.encoding.CustomClassMapper
- serverTimestamp() - Static method in class com.google.cloud.firestore.FieldValue
-
Returns a sentinel used with set() or update() to include a server-generated timestamp in the written data.
- ServerTimestamp - Annotation Type in com.google.cloud.firestore.annotation
-
Annotation used to mark a timestamp field as being populated via Server Timestamps.
- set(DocumentReference, Object) - Method in class com.google.cloud.firestore.BulkWriter
-
Write to the document referred to by the provided DocumentReference.
- set(DocumentReference, Object) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Overwrites the document referred to by this DocumentReference.
- set(DocumentReference, Object, SetOptions) - Method in class com.google.cloud.firestore.BulkWriter
-
Write to the document referred to by the provided DocumentReference.
- set(DocumentReference, Object, SetOptions) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Overwrites the document referred to by this DocumentReference.
- set(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter
-
Write to the document referred to by the provided DocumentReference.
- set(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Overwrites the document referred to by this DocumentReference.
- set(DocumentReference, Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.BulkWriter
-
Write to the document referred to by the provided DocumentReference.
- set(DocumentReference, Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Overwrites the document referred to by this DocumentReference.
- set(Object) - Method in class com.google.cloud.firestore.DocumentReference
-
Overwrites the document referred to by this DocumentReference.
- set(Object, SetOptions) - Method in class com.google.cloud.firestore.DocumentReference
-
Writes to the document referred to by this DocumentReference.
- set(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference
-
Overwrites the document referred to by this DocumentReference.
- set(Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.DocumentReference
-
Writes to the document referred to by this DocumentReference.
- setAlwaysUseImplicitOrderBy(boolean) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets whether to always include implicit order by clauses in the query request (e.g., for inequality queries).
- setAnalyze(boolean) - Method in class com.google.cloud.firestore.ExplainOptions.Builder
-
Sets whether analyzing the query is enabled.
- setAttribute(String, boolean) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Adds the given attribute to this span.
- setAttribute(String, int) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Adds the given attribute to this span.
- setAttribute(String, String) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil.Span
-
Adds the given attribute to this span.
- setChannelProvider(TransportChannelProvider) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the
TransportChannelProviderto use with this Firestore client. - setCredentialsProvider(CredentialsProvider) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the
CredentialsProviderto use with this Firestore client. - setDatabaseId(String) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the database ID to use with this Firestore client.
- setDistanceResultField(FieldPath) - Method in class com.google.cloud.firestore.VectorQueryOptions.Builder
-
Specifies the name of the field that will be set on each returned DocumentSnapshot, which will contain the computed distance for the document.
- setDistanceResultField(String) - Method in class com.google.cloud.firestore.VectorQueryOptions.Builder
-
Specifies the name of the field that will be set on each returned DocumentSnapshot, which will contain the computed distance for the document.
- setDistanceThreshold(Double) - Method in class com.google.cloud.firestore.VectorQueryOptions.Builder
-
Specifies a threshold for which no less similar documents will be returned.
- setEmulatorHost(String) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the emulator host to use with this Firestore client.
- setExecutor(Executor) - Method in class com.google.cloud.firestore.TransactionOptions.Builder
- setExecutor(ScheduledExecutorService) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
Set the executor that the BulkWriter instance schedules operations on.
- setInitialOpsPerSecond(int) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
Set the initial maximum number of operations per second allowed by the throttler.
- setMaxOpsPerSecond(int) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
Set the maximum number of operations per second allowed by the throttler.
- setNumberOfAttempts(int) - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder
-
Specify the max number of attempts a transaction will be attempted before resulting in an error.
- setOpenTelemetry(OpenTelemetry) - Method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions.Builder
-
Sets the
OpenTelemetryto use with this Firestore instance. - setOpenTelemetryOptions(FirestoreOpenTelemetryOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the
FirestoreOpenTelemetryOptionsto be used for this Firestore instance. - SetOptions - Class in com.google.cloud.firestore
-
An options object that configures the behavior of set() calls.
- setReadTime(TimestampOrBuilder) - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder
-
Specify to read documents at the given time.
- setThrottlingEnabled(boolean) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
Sets whether throttling should be enabled.
- setTransportOptions(TransportOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
-
Sets the
TransportOptionsto use with this Firestore client. - shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode
- shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
- shouldContinue(K, V) - Method in class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor
- shouldContinue(K, V) - Method in interface com.google.cloud.firestore.collection.LLRBNode.ShortCircuitingNodeVisitor
- shouldCreateEnabledInstance() - Static method in interface com.google.cloud.firestore.telemetry.MetricsUtil
- shutdown() - Method in interface com.google.cloud.firestore.Firestore
-
Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted.
- shutdown() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
- shutdown() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- shutdown() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- shutdown() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- shutdown() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- shutdownNow() - Method in interface com.google.cloud.firestore.Firestore
-
Attempts to stop all actively executing work and halts the processing of waiting work.
- shutdownNow() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc
- shutdownNow() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc
- shutdownNow() - Method in class com.google.cloud.firestore.v1.FirestoreClient
- shutdownNow() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- shutdownNow() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- size() - Method in class com.google.cloud.firestore.collection.ArraySortedMap
- size() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- size() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
- size() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode
- size() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode
- size() - Method in interface com.google.cloud.firestore.collection.LLRBNode
- size() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode
- size() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
- size() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the number of DocumentSnapshots in this snapshot.
- snapshotFromMap(String, Map<String, Object>) - Method in class com.google.cloud.firestore.Internal
- snapshotFromObject(String, Object) - Method in class com.google.cloud.firestore.Internal
- snapshotFromProto(Timestamp, Document) - Method in class com.google.cloud.firestore.Internal
- sort(Ordering...) - Method in class com.google.cloud.firestore.Pipeline
-
Sorts the documents from previous stages based on one or more
Orderingcriteria. - Sort - Class in com.google.cloud.firestore.pipeline.stages
- Sort(ImmutableList<Ordering>) - Constructor for class com.google.cloud.firestore.pipeline.stages.Sort
- split(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits this string or blob expression by a delimiter.
- split(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits a string or blob by a delimiter.
- split(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits a string or blob by a delimiter.
- split(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits this string or blob expression by a delimiter.
- split(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits a string or blob by a delimiter.
- split(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that splits a string or blob by a delimiter.
- sqrt() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the square root of this numeric expression.
- sqrt(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the square root of
numericExpr. - sqrt(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns the square root of
numericField. - Stage - Class in com.google.cloud.firestore.pipeline.stages
-
Parent to all stages.
- StageUtils - Class in com.google.cloud.firestore.pipeline.stages
- StageUtils() - Constructor for class com.google.cloud.firestore.pipeline.stages.StageUtils
- startAfter(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that starts after the provided document (exclusive).
- startAfter(Object...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that starts after the provided fields relative to the order of the query.
- startAt(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that starts at the provided document (inclusive).
- startAt(Object...) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that starts at the provided fields relative to the order of the query.
- startSpan(String) - Method in class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- startSpan(String) - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- startSpan(String) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Starts a new span with the given name, sets it as the current span, and returns it.
- startSpan(String, TraceUtil.Context) - Method in class com.google.cloud.firestore.telemetry.DisabledTraceUtil
- startSpan(String, TraceUtil.Context) - Method in class com.google.cloud.firestore.telemetry.EnabledTraceUtil
- startSpan(String, TraceUtil.Context) - Method in interface com.google.cloud.firestore.telemetry.TraceUtil
-
Starts a new span with the given name and the given context as its parent, sets it as the current span, and returns it.
- startsWith(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression starts with a given
prefix. - startsWith(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression starts with a given
prefix. - startsWith(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this string expression starts with a given
prefix. - startsWith(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression starts with a given
prefix. - startsWith(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression starts with a given
prefix. - stream(ApiStreamObserver<DocumentSnapshot>) - Method in class com.google.cloud.firestore.Query
-
Executes the query and streams the results as a StreamObserver of DocumentSnapshots.
- StreamableQuery<SnapshotType> - Class in com.google.cloud.firestore
-
Represents a query whose results can be streamed.
- stringConcat(Expression...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates string expressions together.
- stringConcat(Expression, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates string expressions together.
- stringConcat(String...) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates string expressions and string constants together.
- stringConcat(String, Object...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that concatenates string expressions together.
- stringContains(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression contains a specified substring.
- stringContains(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string expression contains a specified substring.
- stringContains(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if this string expression contains a specified substring.
- stringContains(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field contains a specified substring.
- stringContains(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that checks if a string field contains a specified substring.
- substring(Expression, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a substring of the given string.
- substring(Object, Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a substring of the given string.
- substring(String, int, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a substring of the given string.
- subtract(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts two expressions.
- subtract(Expression, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a constant value from a numeric expression.
- subtract(Object) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a numeric expressions from this numeric expression.
- subtract(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a numeric expressions from numeric field.
- subtract(String, Number) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a constant from numeric field.
- sum() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an aggregation that calculates the sum of this numeric expression across multiple stage inputs.
- sum(FieldPath) - Static method in class com.google.cloud.firestore.AggregateField
-
Create a
AggregateField.SumAggregateFieldobject that can be used to compute the sum of a specified field over a range of documents in the result set of a query. - sum(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that calculates the sum of values from an expression across multiple stage inputs.
- sum(String) - Static method in class com.google.cloud.firestore.AggregateField
-
Create a
AggregateField.SumAggregateFieldobject that can be used to compute the sum of a specified field over a range of documents in the result set of a query. - sum(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.AggregateFunction
-
Creates an aggregation that calculates the sum of a field's values across multiple stage inputs.
T
- TelemetryConstants - Interface in com.google.cloud.firestore.telemetry
-
Constants used for telemetry in the Firestore SDK.
- TelemetryConstants.MetricType - Enum in com.google.cloud.firestore.telemetry
- ThrowOnExtraProperties - Annotation Type in com.google.cloud.firestore.annotation
-
Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown.
- timestampAdd(Expression, Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to this timestamp expression.
- timestampAdd(Expression, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to a timestamp.
- timestampAdd(Expression, String, long) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to a timestamp.
- timestampAdd(String, long) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to this timestamp expression.
- timestampAdd(String, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to a timestamp.
- timestampAdd(String, String, long) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that adds a specified amount of time to a timestamp.
- timestampSubtract(Expression, Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to this timestamp expression.
- timestampSubtract(Expression, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to a timestamp.
- timestampSubtract(Expression, String, long) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to a timestamp.
- timestampSubtract(String, long) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to this timestamp expression.
- timestampSubtract(String, Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to a timestamp.
- timestampSubtract(String, String, long) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that subtracts a specified amount of time to a timestamp.
- timestampToUnixMicros() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts this timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixMicros(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixMicros(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp field to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixMillis() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts this timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixMillis(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixMillis(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp field to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixSeconds() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts this timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixSeconds(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampToUnixSeconds(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a timestamp field to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).
- timestampTruncate(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates this timestamp expression to a specified granularity.
- timestampTruncate(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity.
- timestampTruncate(Expression, Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
- timestampTruncate(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity.
- timestampTruncate(Expression, String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
- timestampTruncate(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates this timestamp expression to a specified granularity.
- timestampTruncate(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity.
- timestampTruncate(String, Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
- timestampTruncate(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity.
- timestampTruncate(String, String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates a timestamp to a specified granularity in a given timezone.
- toArray() - Method in class com.google.cloud.firestore.VectorValue
-
Returns a representation of the vector as an array of doubles.
- toBuilder() - Method in class com.google.cloud.firestore.BulkWriterOptions
- toBuilder() - Method in class com.google.cloud.firestore.ExplainOptions
- toBuilder() - Method in class com.google.cloud.firestore.FirestoreOpenTelemetryOptions
- toBuilder() - Method in class com.google.cloud.firestore.FirestoreOptions
- toBuilder() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder containing all the values of this settings class.
- toBuilder() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder containing all the values of this settings class.
- toByteBuffer() - Method in class com.google.cloud.firestore.FirestoreBundle
-
Returns the bundle content as a readonly
ByteBuffer. - toBytes() - Method in class com.google.cloud.firestore.Blob
-
Returns a copy of the underlying bytes as a byte[] array.
- toByteString() - Method in class com.google.cloud.firestore.Blob
-
Returns the backing data as a ByteString.
- toLower() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts this string expression to lowercase.
- toLower(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a string expression to lowercase.
- toLower(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a string field to lowercase.
- toMap(AbstractOptions<?>) - Static method in class com.google.cloud.firestore.pipeline.stages.StageUtils
- toObject(Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns the contents of the document converted to a POJO or null if the document doesn't exist.
- toObject(Class<T>) - Method in class com.google.cloud.firestore.QueryDocumentSnapshot
-
Returns the contents of the document converted to a POJO.
- toObjects(Class<T>) - Method in class com.google.cloud.firestore.GenericQuerySnapshot
-
Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.
- toProto() - Method in class com.google.cloud.firestore.AggregateQuery
-
Returns the
RunAggregationQueryRequestthat this AggregateQuery instance represents. - toProto() - Method in class com.google.cloud.firestore.ExplainOptions
- toProto() - Method in class com.google.cloud.firestore.pipeline.expressions.Field
- toProto() - Method in class com.google.cloud.firestore.pipeline.expressions.Ordering
- toProto() - Method in class com.google.cloud.firestore.pipeline.stages.ExplainOptions.ExecutionMode
- toProto() - Method in class com.google.cloud.firestore.Query
-
Returns the
RunQueryRequestthat this Query instance represents. - toProtoValue() - Method in class com.google.cloud.firestore.Pipeline
- toRunQueryRequestBuilder(ByteString, Timestamp, ExplainOptions) - Method in class com.google.cloud.firestore.Query
- toRunQueryRequestBuilder(ByteString, Timestamp, ExplainOptions) - Method in class com.google.cloud.firestore.VectorQuery
- toStageProto(Stage) - Static method in class com.google.cloud.firestore.pipeline.stages.StageUtils
- toString() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
- toString() - Method in class com.google.cloud.firestore.CollectionGroup
- toString() - Method in class com.google.cloud.firestore.DocumentChange
- toString() - Method in class com.google.cloud.firestore.DocumentReference
- toString() - Method in class com.google.cloud.firestore.DocumentSnapshot
- toString() - Method in class com.google.cloud.firestore.FieldPath
- toString() - Method in class com.google.cloud.firestore.GenericQuerySnapshot
- toString() - Method in class com.google.cloud.firestore.GeoPoint
- toString() - Method in enum com.google.cloud.firestore.pipeline.expressions.Ordering.Direction
- toString() - Method in class com.google.cloud.firestore.PipelineResult
- toString() - Method in class com.google.cloud.firestore.StreamableQuery
- toString() - Method in class com.google.cloud.firestore.UpdateBuilder
- toString() - Method in class com.google.cloud.firestore.VectorQuery
- toString() - Method in class com.google.cloud.firestore.VectorQueryOptions
- toString() - Method in class com.google.cloud.firestore.VectorValue
- toUpper() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts this string expression to uppercase.
- toUpper(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a string expression to uppercase.
- toUpper(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a string field to uppercase.
- TraceUtil - Interface in com.google.cloud.firestore.telemetry
-
A utility interface for trace collection.
- TraceUtil.Context - Interface in com.google.cloud.firestore.telemetry
-
Represents a trace context.
- TraceUtil.Scope - Interface in com.google.cloud.firestore.telemetry
-
Represents a trace scope.
- TraceUtil.Span - Interface in com.google.cloud.firestore.telemetry
-
Represents a trace span.
- Transaction - Class in com.google.cloud.firestore
-
A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.
- Transaction(FirestoreImpl) - Constructor for class com.google.cloud.firestore.Transaction
- TRANSACTION_ATTEMPT_COUNT - Enum constant in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
- TRANSACTION_LATENCY - Enum constant in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
- Transaction.AsyncFunction<T> - Interface in com.google.cloud.firestore
-
User callback that takes a Firestore Async Transaction.
- Transaction.Function<T> - Interface in com.google.cloud.firestore
-
User callback that takes a Firestore Transaction.
- TransactionOptions - Class in com.google.cloud.firestore
-
Options specifying the behavior of Firestore Transactions.
- TransactionOptions.Builder<B extends TransactionOptions.Builder<B>> - Class in com.google.cloud.firestore
- TransactionOptions.ReadOnlyOptionsBuilder - Class in com.google.cloud.firestore
-
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only.
- TransactionOptions.ReadWriteOptionsBuilder - Class in com.google.cloud.firestore
-
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write.
- TransactionOptions.TransactionOptionsType - Enum in com.google.cloud.firestore
- transactionTraceContext - Variable in class com.google.cloud.firestore.Transaction
- translate(C) - Method in interface com.google.cloud.firestore.collection.ImmutableSortedMap.Builder.KeyTranslator
- trim() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes leading and trailing whitespace from this string expression.
- trim(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes leading and trailing whitespace from a string expression.
- trim(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes leading and trailing whitespace from a string field.
- trimValue(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of this string or blob expression.
- trimValue(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of a string or blob.
- trimValue(Expression, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of a string or blob.
- trimValue(String) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of this string or blob expression.
- trimValue(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of a string or blob.
- trimValue(String, String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that removes specified characters from the beginning and end of a string or blob.
- trunc() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates this numeric expression to an integer.
- trunc(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericExprto an integer. - trunc(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericFieldto an integer. - truncToPrecision(int) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates this numeric expression to
decimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - truncToPrecision(Expression) - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates this numeric expression to
decimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - truncToPrecision(Expression, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - truncToPrecision(Expression, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericExprtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - truncToPrecision(String, int) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - truncToPrecision(String, Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that truncates
numericFieldtodecimalPlacedecimal places ifdecimalPlaceis positive, truncates digits to the left of the decimal point ifdecimalPlaceis negative. - type() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a string indicating the type of the value this expression evaluates to.
- type(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a string indicating the type of the value this expression evaluates to.
- type(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that returns a string indicating the type of the value this field evaluates to.
U
- unaryMethodSettingsBuilders() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
- union(Pipeline) - Method in class com.google.cloud.firestore.Pipeline
-
Performs union of all documents from two pipelines, including duplicates.
- Union - Class in com.google.cloud.firestore.pipeline.stages
- Union(Pipeline) - Constructor for class com.google.cloud.firestore.pipeline.stages.Union
- unixMicrosToTimestamp() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets this expression as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixMicrosToTimestamp(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that converts a Unix timestamp in microseconds to a Firestore timestamp.
- unixMicrosToTimestamp(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets a field's value as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixMillisToTimestamp() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets this expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixMillisToTimestamp(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets an expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixMillisToTimestamp(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets a field's value as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixSecondsToTimestamp() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets this expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixSecondsToTimestamp(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets an expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unixSecondsToTimestamp(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that interprets a field's value as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.
- unnest(Selectable) - Method in class com.google.cloud.firestore.Pipeline
-
Produces a document for each element in array found in previous stage document.
- unnest(Selectable, UnnestOptions) - Method in class com.google.cloud.firestore.Pipeline
-
Produces a document for each element in array found in previous stage document.
- unnest(String, String) - Method in class com.google.cloud.firestore.Pipeline
-
Produces a document for each element in array found in previous stage document.
- unnest(String, String, UnnestOptions) - Method in class com.google.cloud.firestore.Pipeline
-
Produces a document for each element in array found in previous stage document.
- Unnest - Class in com.google.cloud.firestore.pipeline.stages
- Unnest(Field, String) - Constructor for class com.google.cloud.firestore.pipeline.stages.Unnest
- Unnest(Field, String, UnnestOptions) - Constructor for class com.google.cloud.firestore.pipeline.stages.Unnest
- Unnest(Selectable) - Constructor for class com.google.cloud.firestore.pipeline.stages.Unnest
- Unnest(Selectable, UnnestOptions) - Constructor for class com.google.cloud.firestore.pipeline.stages.Unnest
- UnnestOptions - Class in com.google.cloud.firestore.pipeline.stages
- UnnestOptions() - Constructor for class com.google.cloud.firestore.pipeline.stages.UnnestOptions
- update(DocumentReference, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates the fields in the document referred to by this DocumentReference.
- update(DocumentReference, Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates the fields in the document referred to by this DocumentReference.
- update(DocumentReference, Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates the fields in the document referred to by this DocumentReference.
- update(DocumentReference, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, String, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates the fields in the document referred to by this DocumentReference.
- update(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates fields in the document referred to by this DocumentReference.
- update(DocumentReference, Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.BulkWriter
-
Update fields of the document referred to by the provided
DocumentReference. - update(DocumentReference, Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Updates fields in the document referred to by this DocumentReference.
- update(FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates the fields in the document referred to by this DocumentReference.
- update(Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates the fields in the document referred to by this DocumentReference.
- update(Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates the fields in the document referred to by this DocumentReference.
- update(String, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates the fields in the document referred to by this DocumentReference.
- update(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates fields in the document referred to by this DocumentReference.
- update(Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates fields in the document referred to by this DocumentReference.
- UpdateBuilder<T> - Class in com.google.cloud.firestore
-
Abstract class that collects and bundles all write operations for
TransactionandWriteBatch. - updateCallback(Transaction) - Method in interface com.google.cloud.firestore.Transaction.AsyncFunction
- updateCallback(Transaction) - Method in interface com.google.cloud.firestore.Transaction.Function
- updatedAt(Timestamp) - Static method in class com.google.cloud.firestore.Precondition
-
Creates a Precondition that enforces that the existing document was written at the specified time.
- updateDocument(Document, DocumentMask) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Updates or inserts a document.
- updateDocument(UpdateDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Updates or inserts a document.
- updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Updates or inserts a document.
- updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to updateDocument.
- updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to updateDocument.
- updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to updateDocument.
- updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to updateDocument.
V
- value - Variable in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
- value - Variable in enum com.google.cloud.firestore.pipeline.stages.Sample.Mode
- value() - Element in annotation type com.google.cloud.firestore.annotation.PropertyName
- valueOf(String) - Static method in enum com.google.cloud.firestore.collection.LLRBNode.Color
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.DocumentChange.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.pipeline.expressions.Ordering.Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.pipeline.stages.Sample.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.Query.Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.firestore.VectorQuery.DistanceMeasure
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.cloud.firestore.collection.LLRBNode.Color
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.DocumentChange.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.pipeline.expressions.Ordering.Direction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.pipeline.stages.ReplaceWith.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.pipeline.stages.Sample.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.Query.Direction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.telemetry.TelemetryConstants.MetricType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.google.cloud.firestore.VectorQuery.DistanceMeasure
-
Returns an array containing the constants of this enum type, in the order they are declared.
- vector(double[]) - Static method in class com.google.cloud.firestore.FieldValue
-
Creates a new
VectorValueconstructed with a copy of the given array of doubles. - vectorLength() - Method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length (dimension) of a Firestore Vector.
- vectorLength(Expression) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of a vector.
- vectorLength(String) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that calculates the length of a vector.
- VectorQuery - Class in com.google.cloud.firestore
-
A query that finds the documents whose vector fields are closest to a certain query vector.
- VectorQuery.DistanceMeasure - Enum in com.google.cloud.firestore
-
The distance measure to use when comparing vectors in a
VectorQuery. - VectorQueryOptions - Class in com.google.cloud.firestore
-
Specifies the behavior of the
VectorQuerygenerated by a call toQuery.findNearest(java.lang.String, double[], int, com.google.cloud.firestore.VectorQuery.DistanceMeasure). - VectorQueryOptions.Builder - Class in com.google.cloud.firestore
- VectorQuerySnapshot - Class in com.google.cloud.firestore
-
A VectorQuerySnapshot contains the results of a VectorQuery.
- VectorQuerySnapshot(VectorQuery, Timestamp, List<QueryDocumentSnapshot>, List<DocumentChange>) - Constructor for class com.google.cloud.firestore.VectorQuerySnapshot
- VectorValue - Class in com.google.cloud.firestore
-
Represents a vector in Firestore documents.
- visitEntry(K, V) - Method in class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor
W
- where(Filter) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter.
- where(BooleanExpression) - Method in class com.google.cloud.firestore.Pipeline
-
Filters the documents from previous stages to only include those matching the specified
BooleanExpression. - Where - Class in com.google.cloud.firestore.pipeline.stages
- Where(BooleanExpression) - Constructor for class com.google.cloud.firestore.pipeline.stages.Where
- whereArrayContains(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.
- whereArrayContains(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.
- whereArrayContainsAny(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.
- whereArrayContainsAny(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.
- whereEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.
- whereEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.
- whereGreaterThan(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.
- whereGreaterThan(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.
- whereGreaterThanOrEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.
- whereGreaterThanOrEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.
- whereIn(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.
- whereIn(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.
- whereLessThan(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.
- whereLessThan(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.
- whereLessThanOrEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.
- whereLessThanOrEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.
- whereNotEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal the specified value.
- whereNotEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and its value does not equal the specified value.
- whereNotIn(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.
- whereNotIn(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.
- with(String, boolean) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, double) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, long) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, Field) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, AbstractOptions<?>) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, Value) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, String) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, String[]) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- with(String, List<? extends Expression>) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- withAccumulators(AliasedAggregate...) - Static method in class com.google.cloud.firestore.pipeline.stages.Aggregate
- withArguments(Object...) - Method in class com.google.cloud.firestore.pipeline.stages.RawStage
-
Specify arguments to stage.
- withChanges(Query, Timestamp, DocumentSet, List<DocumentChange>) - Static method in class com.google.cloud.firestore.QuerySnapshot
-
Creates a new QuerySnapshot representing a snapshot of a Query with changed documents.
- withDistanceField(Field) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- withDistanceField(String) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- withDocLimit(int) - Static method in class com.google.cloud.firestore.pipeline.stages.Sample
- withDocuments(Query, Timestamp, List<QueryDocumentSnapshot>) - Static method in class com.google.cloud.firestore.QuerySnapshot
-
Creates a new QuerySnapshot representing the results of a Query with added documents.
- withDocuments(VectorQuery, Timestamp, List<QueryDocumentSnapshot>) - Static method in class com.google.cloud.firestore.VectorQuerySnapshot
-
Creates a new VectorQuerySnapshot representing the results of a VectorQuery with added documents.
- withExecutionMode(ExplainOptions.ExecutionMode) - Method in class com.google.cloud.firestore.pipeline.stages.ExplainOptions
- withExplainOptions(ExplainOptions) - Method in class com.google.cloud.firestore.pipeline.stages.PipelineExecuteOptions
- withForceIndex(String) - Method in class com.google.cloud.firestore.pipeline.stages.CollectionHints
- withGroups(Selectable...) - Method in class com.google.cloud.firestore.pipeline.stages.Aggregate
- withGroups(String...) - Method in class com.google.cloud.firestore.pipeline.stages.Aggregate
- withHints(AggregateHints) - Method in class com.google.cloud.firestore.pipeline.stages.AggregateOptions
- withHints(CollectionHints) - Method in class com.google.cloud.firestore.pipeline.stages.CollectionGroupOptions
- withHints(CollectionHints) - Method in class com.google.cloud.firestore.pipeline.stages.CollectionOptions
- withIndexField(String) - Method in class com.google.cloud.firestore.pipeline.stages.UnnestOptions
- withIndexMode(String) - Method in class com.google.cloud.firestore.pipeline.stages.PipelineExecuteOptions
- withLimit(long) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- withOptions(AggregateOptions) - Method in class com.google.cloud.firestore.pipeline.stages.Aggregate
- withOptions(CollectionGroupOptions) - Method in class com.google.cloud.firestore.pipeline.stages.CollectionGroup
- withOptions(CollectionOptions) - Method in class com.google.cloud.firestore.pipeline.stages.Collection
- withOptions(RawOptions) - Method in class com.google.cloud.firestore.pipeline.stages.RawStage
- withOptions(SampleOptions) - Method in class com.google.cloud.firestore.pipeline.stages.Sample
- withPercentage(double) - Static method in class com.google.cloud.firestore.pipeline.stages.Sample
- withSection(String, RawOptions) - Method in class com.google.cloud.firestore.pipeline.stages.FindNearestOptions
- WriteBatch - Class in com.google.cloud.firestore
-
A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
- writeCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Streams batches of document updates and deletes, in order.
- writeCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub
- writeCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
- writeCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub
- WriteResult - Class in com.google.cloud.firestore
-
A WriteResult exposes the update time set by the server.
- writeSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
Returns the builder for the settings used for calls to write.
- writeSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns the object with the settings used for calls to write.
- writeSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
Returns the builder for the settings used for calls to write.
- writeSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns the object with the settings used for calls to write.
X
- xor(BooleanExpression, BooleanExpression...) - Static method in class com.google.cloud.firestore.pipeline.expressions.Expression
-
Creates an expression that performs a logical 'XOR' operation.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)