AppSearchSchema.StringPropertyConfig.Builder


public static final class AppSearchSchema.StringPropertyConfig.Builder
extends Object

java.lang.Object
   ↳ android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder


Builder for StringPropertyConfig.

Summary

Public constructors

Builder(String propertyName)

Creates a new StringPropertyConfig.Builder.

Public methods

AppSearchSchema.StringPropertyConfig build()

Constructs a new StringPropertyConfig from the contents of this builder.

AppSearchSchema.StringPropertyConfig.Builder setCardinality(int cardinality)

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

AppSearchSchema.StringPropertyConfig.Builder setDescription(String description)

Sets a natural language description of this property.

AppSearchSchema.StringPropertyConfig.Builder setIndexingType(int indexingType)

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

AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType(int joinableValueType)

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

AppSearchSchema.StringPropertyConfig.Builder setTokenizerType(int tokenizerType)

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

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder (String propertyName)

Creates a new StringPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

Added in API level 31
public AppSearchSchema.StringPropertyConfig build ()

Constructs a new StringPropertyConfig from the contents of this builder.

Returns
AppSearchSchema.StringPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setCardinality (int cardinality)

Sets 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: Value is AppSearchSchema.PropertyConfig.CARDINALITY_REPEATED, AppSearchSchema.PropertyConfig.CARDINALITY_OPTIONAL, or AppSearchSchema.PropertyConfig.CARDINALITY_REQUIRED

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setDescription

public AppSearchSchema.StringPropertyConfig.Builder setDescription (String description)

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.

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setIndexingType

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setIndexingType (int indexingType)

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 AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE, so that it cannot be matched by queries.

Parameters
indexingType int: Value is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE, AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_EXACT_TERMS, or AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_PREFIXES

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setJoinableValueType

Added in API level 34
Also in T Extensions 7
public AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType (int joinableValueType)

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

If this method is not called, the default joinable value type is 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 AppSearchSchema.StringPropertyConfig.JOINABLE_VALUE_TYPE_NONE, or AppSearchSchema.StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setTokenizerType

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setTokenizerType (int tokenizerType)

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

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

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

Parameters
tokenizerType int: Value is AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_NONE, AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_PLAIN, AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_VERBATIM, or AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_RFC822

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.