Added in API level 31

Builder

class Builder
kotlin.Any
   ↳ android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder

Builder for StringPropertyConfig.

Summary

Public constructors
Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.
Public methods
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
setDeletePropagationType(deletePropagationType: Int)

Configures how the deletion will be propagated between this document and the referenced document whose qualified id is held by this property.
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

Added in API level 31
Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

Added in API level 31
fun build(): AppSearchSchema.StringPropertyConfig

Constructs a new StringPropertyConfig from the contents of this builder.

Return
AppSearchSchema.StringPropertyConfig This value cannot be null.
Exceptions
java.lang.IllegalStateException if any following condition:

setCardinality

Added in API level 31
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 PropertyConfig.CARDINALITY_OPTIONAL.

Parameters
cardinality Int: Value is one of the following:
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setDeletePropagationType

Added in API level 10000
fun setDeletePropagationType(deletePropagationType: Int): AppSearchSchema.StringPropertyConfig.Builder

Configures how the deletion will be propagated between this document and the referenced document whose qualified id is held by this property.

If this method is not called, the default delete propagation type is StringPropertyConfig.DELETE_PROPAGATION_TYPE_NONE, indicating that deletion will not propagate between this document and the referenced document.

If the delete propagation type is not StringPropertyConfig.DELETE_PROPAGATION_TYPE_NONE, then StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID must also be set since the delete propagation has to use the qualified id. Otherwise, throw IllegalStateException when building.

Parameters
deletePropagationType Int: Value is one of the following:
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setDescription

Added in API level 36.1
Also in T Extensions 18
fun setDescription(description: String): AppSearchSchema.StringPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see AppSearchSchema.PropertyConfig.getDescription.

Parameters
description String: This value cannot be null.
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setIndexingType

Added in API level 31
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 StringPropertyConfig.INDEXING_TYPE_NONE, so that it cannot be matched by queries.

Parameters
indexingType Int: Value is one of the following:
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setJoinableValueType

Added in API level 34
Also in T Extensions 7
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 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 one of the following:
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setTokenizerType

Added in API level 31
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 StringPropertyConfig.TOKENIZER_TYPE_NONE, so that it is not tokenized.

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

Parameters
tokenizerType Int: Value is one of the following:
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.