public final class

AppSearchSchema.DocumentPropertyConfig.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig.Builder

Overview

Builder for AppSearchSchema.DocumentPropertyConfig.

Summary

Constructors
publicBuilder(java.lang.String propertyName, java.lang.String schemaType)

Creates a new AppSearchSchema.DocumentPropertyConfig.Builder.

Methods
public AppSearchSchema.DocumentPropertyConfigbuild()

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

public AppSearchSchema.DocumentPropertyConfig.BuildersetCardinality(int cardinality)

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

public AppSearchSchema.DocumentPropertyConfig.BuildersetShouldIndexNestedProperties(boolean indexNestedProperties)

Configures whether fields in the nested document should be indexed according to that document's schema.

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

Constructors

public Builder(java.lang.String propertyName, java.lang.String schemaType)

Creates a new AppSearchSchema.DocumentPropertyConfig.Builder.

Parameters:

propertyName: The logical name of the property in the schema, which will be used as the key for this property in GenericDocument.Builder.setPropertyDocument(String, GenericDocument...).
schemaType: The type of documents which will be stored in this property. Documents of different types cannot be mixed into a single property.

Methods

public AppSearchSchema.DocumentPropertyConfig.Builder setCardinality(int cardinality)

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.DocumentPropertyConfig.Builder setShouldIndexNestedProperties(boolean indexNestedProperties)

Configures whether fields in the nested document should be indexed according to that document's schema.

If false, the nested document's properties are not indexed regardless of its own schema.

public AppSearchSchema.DocumentPropertyConfig build()

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

Generated Wed, 25 May 2022 15:45:09 +0200 by Michael Jentsch - Privacy Policy - Legal Details