Builder
class Builder
| kotlin.Any | |
| ↳ | android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder |
Builder for StringPropertyConfig.
Summary
| Public constructors | |
|---|---|
|
Creates a new |
|
| Public methods | |
|---|---|
| AppSearchSchema.StringPropertyConfig |
build()Constructs a new |
| AppSearchSchema.StringPropertyConfig.Builder |
setCardinality(cardinality: Int)Sets the cardinality of the property (whether it is optional, required or repeated). |
| AppSearchSchema.StringPropertyConfig.Builder |
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
Builder(propertyName: String)
Creates a new StringPropertyConfig.Builder.
| Parameters | |
|---|---|
propertyName |
String: This value cannot be null. |
Public methods
build
fun build(): AppSearchSchema.StringPropertyConfig
Constructs a new StringPropertyConfig from the contents of this builder.
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig |
This value cannot be null. |
setCardinality
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 android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL.
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig.Builder |
This value cannot be null. |
setDescription
fun setDescription(description: String): AppSearchSchema.StringPropertyConfig.Builder
Sets a natural language description of this property.
For more details about the description field, see android.app.appsearch.AppSearchSchema.PropertyConfig#getDescription.
| Parameters | |
|---|---|
description |
String: This value cannot be null. |
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig.Builder |
This value cannot be null. |
setIndexingType
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 android.app.appsearch.AppSearchSchema.StringPropertyConfig#INDEXING_TYPE_NONE, so that it cannot be matched by queries.
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig.Builder |
This value cannot be null. |
setJoinableValueType
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 android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_NONE, so that it is not joinable.
At most, 64 properties can be set as joinable per schema.
| Parameters | |
|---|---|
joinableValueType |
Int: Value is android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_NONE, or android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_QUALIFIED_ID |
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig.Builder |
This value cannot be null. |
setTokenizerType
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 android.app.appsearch.AppSearchSchema.StringPropertyConfig#TOKENIZER_TYPE_NONE, so that it is not tokenized.
This method must be called with a value other than android.app.appsearch.AppSearchSchema.StringPropertyConfig#TOKENIZER_TYPE_NONE if the property is indexed (that is, if setIndexingType has been called with a value other than android.app.appsearch.AppSearchSchema.StringPropertyConfig#INDEXING_TYPE_NONE).
| Return | |
|---|---|
AppSearchSchema.StringPropertyConfig.Builder |
This value cannot be null. |