AppSearchSchema.StringPropertyConfig.Builder


class AppSearchSchema.StringPropertyConfig.Builder


Builder for StringPropertyConfig.

Summary

Public constructors

Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.

Public functions

AppSearchSchema.StringPropertyConfig

Constructs a new StringPropertyConfig from the contents of this builder.

AppSearchSchema.StringPropertyConfig.Builder
setCardinality(cardinality: Int)

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

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

Sets a natural language description of this property.

AppSearchSchema.StringPropertyConfig.Builder
setIndexingType(indexingType: Int)

Configures how a property should be indexed so that it can be retrieved by queries.

AppSearchSchema.StringPropertyConfig.Builder
setJoinableValueType(joinableValueType: Int)

Configures how this property should be used as a joining matcher.

AppSearchSchema.StringPropertyConfig.Builder
setTokenizerType(tokenizerType: Int)

Configures how this property should be tokenized (split into words).

Public constructors

Builder

Added in 1.1.0-alpha06
Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.

Public functions

build

Added in 1.1.0-alpha06
fun build(): AppSearchSchema.StringPropertyConfig

Constructs a new StringPropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha06
fun setCardinality(cardinality: Int): AppSearchSchema.StringPropertyConfig.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.

setDescription

Added in 1.1.0-alpha06
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
fun setDescription(description: String): AppSearchSchema.StringPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see getDescription.

setIndexingType

Added in 1.1.0-alpha06
fun setIndexingType(indexingType: Int): AppSearchSchema.StringPropertyConfig.Builder

Configures how a property should be indexed so that it can be retrieved by queries.

If this method is not called, the default indexing type is INDEXING_TYPE_NONE, so that it cannot be matched by queries.

setJoinableValueType

Added in 1.1.0-alpha06
fun setJoinableValueType(joinableValueType: Int): AppSearchSchema.StringPropertyConfig.Builder

Configures how this property should be used as a joining matcher.

If this method is not called, the default joinable value type is JOINABLE_VALUE_TYPE_NONE, so that it is not joinable.

At most, 64 properties can be set as joinable per schema.

setTokenizerType

Added in 1.1.0-alpha06
fun setTokenizerType(tokenizerType: Int): AppSearchSchema.StringPropertyConfig.Builder

Configures how this property should be tokenized (split into words).

If this method is not called, the default indexing type is TOKENIZER_TYPE_NONE, so that it is not tokenized.

This method must be called with a value other than TOKENIZER_TYPE_NONE if the property is indexed (that is, if setIndexingType has been called with a value other than INDEXING_TYPE_NONE).