Subclasses:

AppSearchSchema.StringPropertyConfig, AppSearchSchema.LongPropertyConfig, AppSearchSchema.DoublePropertyConfig, AppSearchSchema.BooleanPropertyConfig, AppSearchSchema.BytesPropertyConfig, AppSearchSchema.DocumentPropertyConfig, AppSearchSchema.EmbeddingPropertyConfig

Overview

Common configuration for a single property (field) in a Document.

For example, an EmailMessage would be a type and the subject would be a property.

Summary

Fields

Constant value for String data type.

Constant value for Long data type.

Constant value for Double data type.

Constant value for Boolean data type.

Unstructured BLOB.

Indicates that the property is itself a GenericDocument, making it part of a hierarchical schema. Any property using this DataType MUST have a valid AppSearchSchema.getSchemaType().

Indicates that the property is an EmbeddingVector.

Any number of items (including zero) [0...*].

Zero or one value [0,1].

Exactly one value [1].

Methods

Returns the name of this property.

Returns a natural language description of this property.

Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives".

This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.

Returns the type of data the property contains (such as string, int, bytes, etc).

Returns the cardinality of the property (whether it is optional, required or repeated).

Converts a into a AppSearchSchema.PropertyConfig depending on its internal data type.

The bundle is not cloned.