Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder

Builder for DocumentPropertyConfig.

Summary

Public constructors
`Builder(propertyName: String, schemaType: String)` Creates a new `DocumentPropertyConfig.Builder`.

Public methods
AppSearchSchema.DocumentPropertyConfig.Builder	`addIndexableNestedProperties(vararg indexableNestedProperties: String!)` Adds one or more properties for indexing from the nested document property.
AppSearchSchema.DocumentPropertyConfig.Builder	`addIndexableNestedProperties(indexableNestedProperties: MutableCollection<String!>)` Adds one or more properties for indexing from the nested document.
AppSearchSchema.DocumentPropertyConfig.Builder	`addIndexableNestedPropertyPaths(vararg indexableNestedPropertyPaths: PropertyPath!)` Adds one or more property paths for indexing from the nested document property.
AppSearchSchema.DocumentPropertyConfig.Builder	`addIndexableNestedPropertyPaths(indexableNestedPropertyPaths: MutableCollection<PropertyPath!>)` Adds one or more property paths for indexing from the nested document property.
AppSearchSchema.DocumentPropertyConfig	`build()` Constructs a new `PropertyConfig` from the contents of this builder.
AppSearchSchema.DocumentPropertyConfig.Builder	`setCardinality(cardinality: Int)` Sets the cardinality of the property (whether it is optional, required or repeated).
AppSearchSchema.DocumentPropertyConfig.Builder	`setShouldIndexNestedProperties(indexNestedProperties: Boolean)` Configures whether properties in the nested document should be indexed according to that document's schema.

Public constructors

Builder

Added in API level 31

Builder(
    propertyName: String, 
    schemaType: String)

Creates a new DocumentPropertyConfig.Builder.

Parameters
`propertyName`	String: The logical name of the property in the schema, which will be used as the key for this property in `android.app.appsearch.GenericDocument.Builder#setPropertyDocument`. This value cannot be `null`.
`schemaType`	String: The type of documents which will be stored in this property. Documents of different types cannot be mixed into a single property. This value cannot be `null`.

Public methods

addIndexableNestedProperties

Added in API level 35

fun addIndexableNestedProperties(vararg indexableNestedProperties: String!): AppSearchSchema.DocumentPropertyConfig.Builder

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

Parameters
`indexableNestedProperties`	String!: This value cannot be `null`.

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.

See Also

#addIndexableNestedProperties(Collection)

addIndexableNestedProperties

Added in API level 35

fun addIndexableNestedProperties(indexableNestedProperties: MutableCollection<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:

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

DocumentPropertyConfig.Builder#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.

Parameters
`indexableNestedProperties`	MutableCollection<String!>: This value cannot be `null`.

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.

addIndexableNestedPropertyPaths

Added in API level 35

fun addIndexableNestedPropertyPaths(vararg indexableNestedPropertyPaths: PropertyPath!): AppSearchSchema.DocumentPropertyConfig.Builder

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

Parameters
`indexableNestedPropertyPaths`	PropertyPath!: This value cannot be `null`.

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.

See Also

#addIndexableNestedProperties(Collection)

addIndexableNestedPropertyPaths

Added in API level 35

fun addIndexableNestedPropertyPaths(indexableNestedPropertyPaths: MutableCollection<PropertyPath!>): AppSearchSchema.DocumentPropertyConfig.Builder

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

Parameters
`indexableNestedPropertyPaths`	MutableCollection<PropertyPath!>: This value cannot be `null`.

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.

See Also

#addIndexableNestedProperties(Collection)

build

Added in API level 31

fun build(): AppSearchSchema.DocumentPropertyConfig

Constructs a new PropertyConfig from the contents of this builder.

Return
`AppSearchSchema.DocumentPropertyConfig`	This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	if the provided PropertyConfig sets `shouldIndexNestedProperties()` to true and has one or more properties defined using `addIndexableNestedProperties(java.util.Collection)`.

setCardinality

Added in API level 31

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 android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL.

Parameters
`cardinality`	Int: Value is `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED`, `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL`, or `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED`

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.

setShouldIndexNestedProperties

Added in API level 31

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(java.util.Collection).

Return
`AppSearchSchema.DocumentPropertyConfig.Builder`	This value cannot be `null`.