Indexable

public interface Indexable

Represents an indexable unit.

Indexables are constructed via Indexable.Builder and indexed via FirebaseAppIndex.update(Indexable...). Convenience methods to construct Indexable objects for common data types are available via Indexables.

Indexables are not thread-safe. Do not create, modify, or access one Indexable from different threads, otherwise a ConcurrentModificationException could be thrown.

Nested Class Summary

class	Indexable.Builder		The builder for `Indexable`.
interface	Indexable.Metadata		Represents the metadata for an `Indexable`.

Constant Summary

int	MAX_BYTE_SIZE	The maximum byte size of an `Indexable`.
int	MAX_INDEXABLES_TO_BE_UPDATED_IN_ONE_CALL	The maximum number of arguments that can be passed to `FirebaseAppIndex.update(Indexable...)` or `FirebaseAppIndex.remove(String...)`.
int	MAX_NESTING_DEPTH	The maximum nesting depth of `Indexable`s.
int	MAX_NUMBER_OF_FIELDS	The maximum number of fields an `Indexable` can have.
int	MAX_REPEATED_SIZE	The maximum number of elements in a repeatable `Indexable` field.
int	MAX_STRING_LENGTH	The maximum `String.length()` of a `String` field of an `Indexable`.
int	MAX_URL_LENGTH	The maximum `String.length()` of an `Indexable` URL string.

Constants

public static final int MAX_BYTE_SIZE

The maximum byte size of an Indexable.

Constant Value: 30000

public static final int MAX_INDEXABLES_TO_BE_UPDATED_IN_ONE_CALL

The maximum number of arguments that can be passed to FirebaseAppIndex.update(Indexable...) or FirebaseAppIndex.remove(String...).

Constant Value: 1000

public static final int MAX_NESTING_DEPTH

The maximum nesting depth of Indexables.

Constant Value: 5

public static final int MAX_NUMBER_OF_FIELDS

The maximum number of fields an Indexable can have.

Constant Value: 20

public static final int MAX_REPEATED_SIZE

The maximum number of elements in a repeatable Indexable field. Additional elements will be discarded.

Constant Value: 100

public static final int MAX_STRING_LENGTH

The maximum String.length() of a String field of an Indexable. Strings longer than this will be truncated.

Constant Value: 20000

public static final int MAX_URL_LENGTH

The maximum String.length() of an Indexable URL string.

Constant Value: 256