public final class

AppSearchSchema.StringPropertyConfig.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.appsearch.app.AppSearchSchema.StringPropertyConfig.Builder

Overview

Builder for AppSearchSchema.StringPropertyConfig.

Summary

Constructors
publicBuilder(java.lang.String propertyName)

Creates a new AppSearchSchema.StringPropertyConfig.Builder.

Methods
public AppSearchSchema.StringPropertyConfigbuild()

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

public AppSearchSchema.StringPropertyConfig.BuildersetCardinality(int cardinality)

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

public AppSearchSchema.StringPropertyConfig.BuildersetDescription(java.lang.String description)

Sets a natural language description of this property.

public AppSearchSchema.StringPropertyConfig.BuildersetIndexingType(int indexingType)

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

public AppSearchSchema.StringPropertyConfig.BuildersetJoinableValueType(int joinableValueType)

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

public AppSearchSchema.StringPropertyConfig.BuildersetTokenizerType(int tokenizerType)

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

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder(java.lang.String propertyName)

Creates a new AppSearchSchema.StringPropertyConfig.Builder.

Methods

public AppSearchSchema.StringPropertyConfig.Builder setDescription(java.lang.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 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 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 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 AppSearchSchema.StringPropertyConfig.Builder.setIndexingType(int) has been called with a value other than AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE).

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

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

Generated Fri, 13 Sep 2024 06:45:08 +0000 by Michael Jentsch - Privacy Policy - Legal Details