AppSearchSchema.DocumentPropertyConfig

Kotlin |Java

public final class AppSearchSchema.DocumentPropertyConfig extends AppSearchSchema.PropertyConfig

java.lang.Object
↳	androidx.appsearch.app.AppSearchSchema.PropertyConfig
	↳	androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document.

Summary

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

Public methods
`@NonNull List<String>`	`getIndexableNestedProperties()` Returns the list of indexable nested properties for the nested document.
`@NonNull 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.

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

`boolean`	`equals(@Nullable Object other)`
`int`	`getCardinality()` Returns the cardinality of the property (whether it is optional, required or repeated).
`@NonNull String`	`getDescription()` Returns a natural language description of this property.
`@NonNull String`	`getName()` Returns the name of this property.
`int`	`hashCode()`
`@NonNull String`	`toString()`

public @NonNull List<String> getIndexableNestedProperties()

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

public @NonNull String getSchemaType()

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

public boolean shouldIndexNestedProperties()

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.