Added in API level 31

Summary: Ctors | Methods | Inherited Methods

AppSearchSchema.StringPropertyConfig.Builder

Kotlin |Java

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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

Throws

Throws
`IllegalStateException`	if any following condition: Tokenizer type is not `StringPropertyConfig.TOKENIZER_TYPE_NONE` with indexing type `StringPropertyConfig.INDEXING_TYPE_NONE`. Indexing type is not `StringPropertyConfig.INDEXING_TYPE_NONE` with tokenizer type `StringPropertyConfig.TOKENIZER_TYPE_NONE`. `StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID` is set to a `PropertyConfig.CARDINALITY_REPEATED` property. Deletion type other than `ERROR(/android.app.appsearch.AppSearchSchema.StringPropertyConfig#DELETE_PROPAGATION_TYPE_NONE)` is used without setting `StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID`.

IllegalStateException

if any following condition:

Tokenizer type is not StringPropertyConfig.TOKENIZER_TYPE_NONE with indexing type StringPropertyConfig.INDEXING_TYPE_NONE.
Indexing type is not StringPropertyConfig.INDEXING_TYPE_NONE with tokenizer type StringPropertyConfig.TOKENIZER_TYPE_NONE.
StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID is set to a PropertyConfig.CARDINALITY_REPEATED property.
Deletion type other than ERROR(/android.app.appsearch.AppSearchSchema.StringPropertyConfig#DELETE_PROPAGATION_TYPE_NONE) is used without setting StringPropertyConfig.JOINABLE_VALUE_TYPE_QUALIFIED_ID.

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

Added in version 36.1
Also in T Extensions 18

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