AppSearchSchema.DocumentPropertyConfig.Builder

public static final class AppSearchSchema.DocumentPropertyConfig.Builder
extends Object

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


Builder for AppSearchSchema.DocumentPropertyConfig.

Summary

Public constructors

Builder(String propertyName, String schemaType)

Creates a new AppSearchSchema.DocumentPropertyConfig.Builder.

Public methods

AppSearchSchema.DocumentPropertyConfig build()

Constructs a new AppSearchSchema.PropertyConfig from the contents of this builder.

AppSearchSchema.DocumentPropertyConfig.Builder setCardinality(int cardinality)

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

AppSearchSchema.DocumentPropertyConfig.Builder setShouldIndexNestedProperties(boolean indexNestedProperties)

Configures whether fields in the nested document should be indexed according to that document's schema.

Inherited methods

Public constructors

Builder

public Builder (String propertyName, 
                String schemaType)

Creates a new AppSearchSchema.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 GenericDocument.Builder.setPropertyDocument(String, GenericDocument...).

schemaType String: The type of documents which will be stored in this property. Documents of different types cannot be mixed into a single property.

Public methods

build

public AppSearchSchema.DocumentPropertyConfig build ()

Constructs a new AppSearchSchema.PropertyConfig from the contents of this builder.

Returns
AppSearchSchema.DocumentPropertyConfig

setCardinality

public AppSearchSchema.DocumentPropertyConfig.Builder setCardinality (int cardinality)

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

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

Parameters
cardinality int

Returns
AppSearchSchema.DocumentPropertyConfig.Builder

setShouldIndexNestedProperties

public AppSearchSchema.DocumentPropertyConfig.Builder setShouldIndexNestedProperties (boolean indexNestedProperties)

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

Parameters
indexNestedProperties boolean

Returns
AppSearchSchema.DocumentPropertyConfig.Builder