AppSearchSchema.DocumentPropertyConfig.Builder

Builder(propertyName: String, schemaType: String)

Creates a new DocumentPropertyConfig.Builder.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_ADD_INDEXABLE_NESTED_PROPERTIES)
fun addIndexableNestedProperties(indexableNestedProperties: Array<String!>): AppSearchSchema.DocumentPropertyConfig.Builder

Adds one or more properties for indexing from the nested document property.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_ADD_INDEXABLE_NESTED_PROPERTIES)
fun addIndexableNestedProperties(
    indexableNestedProperties: (Mutable)Collection<String!>
): AppSearchSchema.DocumentPropertyConfig.Builder

Adds one or more properties for indexing from the nested document. The added property will be indexed according to that property's indexing configurations in the document's schema definition. All properties in this list will consume a sectionId regardless of its actual indexing config -- this includes properties added that do not actually exist, as well as properties that are not set as indexable in the nested schema type.

Input strings should follow the format of the property path for the nested property, with '.' as the path separator. This nested document's property name should not be included in the property path.

Ex. Consider an 'Organization' schema type which defines a nested document property 'address' (Address schema type), where Address has a nested document property 'country' (Country schema type with string 'name' property), and a string 'street' property. The 'street' and 'country's name' properties from the 'address' document property can be indexed for the 'Organization' schema type by calling:

OrganizationSchema.addProperty(
                new DocumentPropertyConfig.Builder("address", "Address")
                        .addIndexableNestedProperties("street", "country.name")
                        .build()).

setShouldIndexNestedProperties is required to be false if any indexable nested property is added this way for the document property. Attempting to build a DocumentPropertyConfig when this is not true throws IllegalArgumentException.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_ADD_INDEXABLE_NESTED_PROPERTIES)
fun addIndexableNestedPropertyPaths(
    indexableNestedPropertyPaths: Array<PropertyPath!>
): AppSearchSchema.DocumentPropertyConfig.Builder

Adds one or more property paths for indexing from the nested document property.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_ADD_INDEXABLE_NESTED_PROPERTIES)
fun addIndexableNestedPropertyPaths(
    indexableNestedPropertyPaths: (Mutable)Collection<PropertyPath!>
): AppSearchSchema.DocumentPropertyConfig.Builder

Adds one or more property paths for indexing from the nested document property.

fun build(): AppSearchSchema.DocumentPropertyConfig

Constructs a new PropertyConfig from the contents of this builder.

fun setCardinality(cardinality: Int): AppSearchSchema.DocumentPropertyConfig.Builder

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

If this method is not called, the default cardinality is CARDINALITY_OPTIONAL.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
@ExperimentalAppSearchApi
fun setDescription(description: String): AppSearchSchema.DocumentPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see getDescription.

fun setShouldIndexNestedProperties(indexNestedProperties: Boolean): AppSearchSchema.DocumentPropertyConfig.Builder

Configures 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.

To index a subset of properties from the nested document, set this to false and use addIndexableNestedProperties.