AppSearchSchema.PropertyConfig

Kotlin |Java

abstract class AppSearchSchema.PropertyConfig

Known direct subclasses

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

`AppSearchSchema.BlobHandlePropertyConfig`	Configuration for a property of type `AppSearchBlobHandle` in a Document.
`AppSearchSchema.BooleanPropertyConfig`	Configuration for a property containing a boolean.
`AppSearchSchema.BytesPropertyConfig`	Configuration for a property containing a byte array.
`AppSearchSchema.DocumentPropertyConfig`	Configuration for a property containing another Document.
`AppSearchSchema.DoublePropertyConfig`	Configuration for a property containing a double-precision decimal number.
`AppSearchSchema.EmbeddingPropertyConfig`	Configuration for a property of type `EmbeddingVector` in a Document.
`AppSearchSchema.LongPropertyConfig`	Configuration for a property containing a 64-bit integer.
`AppSearchSchema.StringPropertyConfig`	Configuration for a property of type String in a Document.

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

Constants
`const Int`	`CARDINALITY_OPTIONAL = 2` Zero or one value [0,1].
`const Int`	`CARDINALITY_REPEATED = 1` Any number of items (including zero) [0...*].
`const Int`	`CARDINALITY_REQUIRED = 3` Exactly one value [1].

Public functions
`Boolean`	`equals(other: Any?)`
`Int`	`getCardinality()` Returns the cardinality of the property (whether it is optional, required or repeated).
`String`	`@ExperimentalAppSearchApi getDescription()` Returns a natural language description of this property.
`String`	`getName()` Returns the name of this property.
`Int`	`hashCode()`
`String`	`toString()`

Constants

CARDINALITY_OPTIONAL

Added in 1.1.0-alpha07

const val CARDINALITY_OPTIONAL = 2: Int

Zero or one value [0,1].

CARDINALITY_REPEATED

Added in 1.1.0-alpha07

const val CARDINALITY_REPEATED = 1: Int

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

CARDINALITY_REQUIRED

Added in 1.1.0-alpha07

const val CARDINALITY_REQUIRED = 3: Int

Exactly one value [1].

Public functions

equals

fun equals(other: Any?): Boolean

getCardinality

Added in 1.1.0-alpha07

fun getCardinality(): Int

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

getDescription

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun getDescription(): String

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.

getName

Added in 1.1.0-alpha07

fun getName(): String

Returns the name of this property.

hashCode

fun hashCode(): Int

toString

fun toString(): String