# Print output for @column tags ?> AppSearchSchema.StringPropertyConfig.Builder - Android SDK | Android Developers

Most visited

Recently visited

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)

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

AppSearchSchema.StringPropertyConfig.Builder setIndexingType(int indexingType)

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

AppSearchSchema.StringPropertyConfig.Builder setTokenizerType(int tokenizerType)

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

Inherited methods

Public constructors

Builder

public Builder (String propertyName)

Creates a new StringPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

public AppSearchSchema.StringPropertyConfig build ()

Constructs a new StringPropertyConfig from the contents of this builder.

Returns
AppSearchSchema.StringPropertyConfig This value cannot be null.

setCardinality

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

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

setIndexingType

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.

setTokenizerType

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 (i.e. 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, or AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_PLAIN

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