AppSearchSchema.StringPropertyConfig.Builder

public static final class AppSearchSchema.StringPropertyConfig.Builder extends Object

Public Constructor Summary

Public Method Summary

AppSearchSchema.StringPropertyConfig
build()
Constructs a new AppSearchSchema.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 Method Summary

Public Constructors

public Builder (String propertyName)

Public Methods

public AppSearchSchema.StringPropertyConfig build ()

Constructs a new AppSearchSchema.StringPropertyConfig from the contents of this builder.

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.

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().

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.

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.

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).