Indexable

public interfaceIndexable

Represents an indexable unit.

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

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

Nested Class Summary

classIndexable.BuilderThe builder forIndexable
interfaceIndexable.MetadataRepresents the metadata for anIndexable

Constant Summary

int MAX_BYTE_SIZEThe maximum byte size of anIndexable.
int MAX_INDEXABLES_TO_BE_UPDATED_IN_ONE_CALLThe maximum number of arguments that can be passed to FirebaseAppIndex.update(Indexable...) or FirebaseAppIndex.remove(String...).
int MAX_NESTING_DEPTHThe maximum nesting depth ofIndexables.
int MAX_NUMBER_OF_FIELDSThe maximum number of fields anIndexable can have.
int MAX_REPEATED_SIZEThe maximum number of elements in a repeatableIndexable field.
int MAX_STRING_LENGTHThe maximumString.length() of aString field of anIndexable.
int MAX_URL_LENGTHThe maximumString.length() of anIndexable URL string.

Constants

public static final intMAX_BYTE_SIZE

The maximum byte size of anIndexable.

Constant Value:30000

public static final intMAX_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 intMAX_NESTING_DEPTH

The maximum nesting depth ofIndexables.

Constant Value:5

public static final intMAX_NUMBER_OF_FIELDS

The maximum number of fields anIndexable can have.

Constant Value:20

public static final intMAX_REPEATED_SIZE

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

Constant Value:100

public static final intMAX_STRING_LENGTH

The maximumString.length() of aString field of anIndexable.Strings longer than this will be truncated.

Constant Value:20000

public static final intMAX_URL_LENGTH

The maximumString.length() of anIndexable URL string.

Constant Value:256

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-02-11 UTC.