AppSearchSchema.DocumentPropertyConfig

public final class AppSearchSchema.DocumentPropertyConfig extends AppSearchSchema.PropertyConfig


Configuration for a property containing another Document.

Summary

Nested types

Builder for DocumentPropertyConfig.

Public methods

@NonNull List<String>

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

@NonNull String

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

boolean

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

Inherited Constants

From androidx.appsearch.app.AppSearchSchema.PropertyConfig
static final int

Zero or one value [0,1].

static final int

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

static final int

Exactly one value [1].

Inherited methods

From androidx.appsearch.app.AppSearchSchema.PropertyConfig
boolean
int

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

@NonNull String

Returns the name of this property.

int
@NonNull String

Public methods

getIndexableNestedProperties

Added in 1.1.0-alpha04
public @NonNull List<StringgetIndexableNestedProperties()

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

TODO(b/291122592): Unhide in Mainline when API updates via Mainline are possible. -->

getSchemaType

Added in 1.1.0-alpha04
public @NonNull String getSchemaType()

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

shouldIndexNestedProperties

Added in 1.1.0-alpha04
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.