Indexable

  • Indexable represents an indexable unit within the Google App Indexing API and is not thread-safe, meaning it should not be accessed from multiple threads concurrently to avoid ConcurrentModificationException.

  • Developers can construct Indexable objects using the provided Indexable.Builder class and associate metadata with them through the Indexable.Metadata interface.

  • Several constants define limits for Indexable objects, including maximum byte size (MAX_BYTE_SIZE), maximum string length (MAX_STRING_LENGTH), and maximum URL length (MAX_URL_LENGTH).

  • The THING constant represents the predefined "Thing" type for Indexable objects.

  • There is a limit on the number of indexables that can be updated in a single call (MAX_INDEXABLES_TO_BE_UPDATED_IN_ONE_CALL), and a limit on the number of elements in a repeatable field (MAX_REPEATED_SIZE).

public interface Indexable

Represents an indexable unit.

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
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.
String THING Names of the predefined Indexable type Thing.

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

Constant Value: 1000

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. String values 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

public static final String THING

Names of the predefined Indexable type Thing.

Constant Value: "Thing"