AppSearchSchema.DocumentPropertyConfig

AI-generated Key Takeaways

AppSearchSchema.DocumentPropertyConfig is a configuration for a property that contains another Document.
It includes methods to get the list of indexable nested properties and the schema type of the contained document.
It provides a method to determine if properties in the nested document should be indexed based on that document's schema.

public static final class AppSearchSchema.DocumentPropertyConfig extends AppSearchSchema.PropertyConfig

Configuration for a property containing another Document.

class AppSearchSchema.DocumentPropertyConfig.Builder Builder for AppSearchSchema.DocumentPropertyConfig.

int	CARDINALITY_OPTIONAL	Zero or one value [0,1].
int	CARDINALITY_REPEATED	Any number of items (including zero) [0...*].
int	CARDINALITY_REQUIRED	Exactly one value [1].

List<String>	getIndexableNestedProperties() Returns the list of indexable nested properties for the nested document.
String	getSchemaType() Returns the logical schema-type of the contents of this document property.
boolean	shouldIndexNestedProperties() Returns whether properties in the nested document should be indexed according to that document's schema.

boolean	equals(Object other)
int	getCardinality() Returns the cardinality of the property (whether it is optional, required or repeated).
String	getDescription() Returns a natural language description of this property.
String	getName() Returns the name of this property.
int	hashCode()
String	toString()

From class java.lang.Object

Returns the list of indexable nested properties for the nested document.

Returns the logical schema-type of the contents of this document property.

Returns whether properties 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.