Builder
class Builder
kotlin.Any | |
↳ | android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig.Builder |
Builder for EmbeddingPropertyConfig
.
Summary
Public constructors | |
---|---|
Creates a new |
Public methods | |
---|---|
AppSearchSchema.EmbeddingPropertyConfig |
build() Constructs a new |
AppSearchSchema.EmbeddingPropertyConfig.Builder |
setCardinality(cardinality: Int) Sets the cardinality of the property (whether it is optional, required or repeated). |
AppSearchSchema.EmbeddingPropertyConfig.Builder |
setDescription(description: String) Sets a natural language description of this property. |
AppSearchSchema.EmbeddingPropertyConfig.Builder |
setIndexingType(indexingType: Int) Configures how a property should be indexed so that it can be retrieved by queries. |
Public constructors
Builder
Builder(propertyName: String)
Creates a new EmbeddingPropertyConfig.Builder
.
Parameters | |
---|---|
propertyName |
String: This value cannot be null . |
Public methods
build
fun build(): AppSearchSchema.EmbeddingPropertyConfig
Constructs a new EmbeddingPropertyConfig
from the contents of this builder.
Return | |
---|---|
AppSearchSchema.EmbeddingPropertyConfig |
This value cannot be null . |
setCardinality
fun setCardinality(cardinality: Int): AppSearchSchema.EmbeddingPropertyConfig.Builder
Sets the cardinality of the property (whether it is optional, required or repeated).
If this method is not called, the default cardinality is android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL
.
Return | |
---|---|
AppSearchSchema.EmbeddingPropertyConfig.Builder |
This value cannot be null . |
setDescription
fun setDescription(description: String): AppSearchSchema.EmbeddingPropertyConfig.Builder
Sets a natural language description of this property.
For more details about the description field, see android.app.appsearch.AppSearchSchema.PropertyConfig#getDescription
.
Parameters | |
---|---|
description |
String: This value cannot be null . |
Return | |
---|---|
AppSearchSchema.EmbeddingPropertyConfig.Builder |
This value cannot be null . |
setIndexingType
fun setIndexingType(indexingType: Int): AppSearchSchema.EmbeddingPropertyConfig.Builder
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 android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig#INDEXING_TYPE_NONE
, so that it will not be indexed and cannot be matched by queries.
Return | |
---|---|
AppSearchSchema.EmbeddingPropertyConfig.Builder |
This value cannot be null . |