AppSearchSchema.DoublePropertyConfig.Builder

Artifact: androidx.appsearch:appsearch

View Source

Added in 1.1.0-alpha07

---

Kotlin |Java

public final class AppSearchSchema.DoublePropertyConfig.Builder

---

Builder for DoublePropertyConfig.

Summary

Public constructors
Builder(@NonNull String propertyName) Creates a new DoublePropertyConfig.Builder.

Public methods
@NonNull AppSearchSchema.DoublePropertyConfig	build() Constructs a new DoublePropertyConfig from the contents of this builder.
@NonNull AppSearchSchema.DoublePropertyConfig.Builder	setCardinality(int cardinality) Sets the cardinality of the property (whether it is optional, required or repeated).
@NonNull AppSearchSchema.DoublePropertyConfig.Builder	@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION) @ExperimentalAppSearchApi setDescription(@NonNull String description) Sets a natural language description of this property.
@NonNull AppSearchSchema.DoublePropertyConfig.Builder	@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SCORABLE_PROPERTY_CONFIG) @ExperimentalAppSearchApi setScoringEnabled(boolean scoringEnabled) Sets the property enabled or disabled for scoring.

Public constructors

Builder

Added in 1.1.0-alpha07

public Builder(@NonNull String propertyName)

Creates a new DoublePropertyConfig.Builder.

Public methods

build

Added in 1.1.0-alpha07

public @NonNull AppSearchSchema.DoublePropertyConfig build()

Constructs a new DoublePropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha07

public @NonNull AppSearchSchema.DoublePropertyConfig.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 CARDINALITY_OPTIONAL.

setDescription

Added in 1.1.0-alpha07

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
@ExperimentalAppSearchApi
public @NonNull AppSearchSchema.DoublePropertyConfig.Builder setDescription(@NonNull String description)

Sets a natural language description of this property.

For more details about the description field, see getDescription.

setScoringEnabled

Added in 1.1.0-alpha07

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SCORABLE_PROPERTY_CONFIG)
@ExperimentalAppSearchApi
public @NonNull AppSearchSchema.DoublePropertyConfig.Builder setScoringEnabled(boolean scoringEnabled)

Sets the property enabled or disabled for scoring.

If this method is not called, the default value is false.

If enabled, it can be used in the advanced ranking expression via the function of 'getScorableProperty'.

For the detailed documentation, see setRankingStrategy.