AppSearchSchema.DocumentPropertyConfig

Kotlin |Java

class AppSearchSchema.DocumentPropertyConfig : AppSearchSchema.PropertyConfig

kotlin.Any
↳	androidx.appsearch.app.AppSearchSchema.PropertyConfig
	↳	androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document.

Summary

Nested types
`class AppSearchSchema.DocumentPropertyConfig.Builder` Builder for `DocumentPropertyConfig`.

Public functions
`(Mutable)List<String!>`	`getIndexableNestedProperties()` Returns the list of indexable nested properties for the nested document.
`String`	`getSchemaType()` Returns the logical schema-type of the contents of this document property.
`Boolean`	`shouldIndexNestedProperties()` Returns whether properties in the nested document should be indexed according to that document's schema.

`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].

`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()`

fun getIndexableNestedProperties(): (Mutable)List<String!>

Returns the list of indexable nested properties for the nested document.

fun getSchemaType(): String

Returns the logical schema-type of the contents of this document property.

fun shouldIndexNestedProperties(): Boolean

Returns whether properties in the nested document should be indexed according to that document's schema.

If false, the nested document's properties are not indexed regardless of its own schema.

See also
`addIndexableNestedProperties`	for indexing a subset of properties from the nested document.