Language

AppSearchSchema.DocumentPropertyConfig.Builder.AddIndexableNestedProperties Method

Definition

Overloads

Name Description
AddIndexableNestedProperties(ICollection<String>)

Adds one or more properties for indexing from the nested document.

AddIndexableNestedProperties(String[])

Adds one or more properties for indexing from the nested document property.

AddIndexableNestedProperties(ICollection<String>)

Adds one or more properties for indexing from the nested document.

[Android.Runtime.Register("addIndexableNestedProperties", "(Ljava/util/Collection;)Landroid/app/appsearch/AppSearchSchema$DocumentPropertyConfig$Builder;", "", ApiSince=35)]
public Android.App.AppSearch.AppSearchSchema.DocumentPropertyConfig.Builder AddIndexableNestedProperties(System.Collections.Generic.ICollection<string> indexableNestedProperties);
[<Android.Runtime.Register("addIndexableNestedProperties", "(Ljava/util/Collection;)Landroid/app/appsearch/AppSearchSchema$DocumentPropertyConfig$Builder;", "", ApiSince=35)>]
member this.AddIndexableNestedProperties : System.Collections.Generic.ICollection<string> -> Android.App.AppSearch.AppSearchSchema.DocumentPropertyConfig.Builder

Parameters

indexableNestedProperties
ICollection<String>

Returns

Attributes

Remarks

Adds one or more properties for indexing from the nested document. The added property will be indexed according to that property's indexing configurations in the document's schema definition. All properties in this list will consume a sectionId regardless of its actual indexing config -- this includes properties added that do not actually exist, as well as properties that are not set as indexable in the nested schema type. Input strings should follow the format of the property path for the nested property, with '.' as the path separator. This nested document's property name should not be included in the property path. Ex. Consider an 'Organization' schema type which defines a nested document property 'address' (Address schema type), where Address has a nested document property 'country' (Country schema type with string 'name' property), and a string 'street' property. The 'street' and 'country's name' properties from the 'address' document property can be indexed for the 'Organization' schema type by calling: DocumentPropertyConfig.Builder.setShouldIndexNestedProperties is required to be false if any indexable nested property is added this way for the document property. Attempting to build a DocumentPropertyConfig when this is not true throws IllegalArgumentException.

Android reference for android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder.addIndexableNestedProperties.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

AddIndexableNestedProperties(String[])

Adds one or more properties for indexing from the nested document property.

[Android.Runtime.Register("addIndexableNestedProperties", "([Ljava/lang/String;)Landroid/app/appsearch/AppSearchSchema$DocumentPropertyConfig$Builder;", "", ApiSince=35)]
public Android.App.AppSearch.AppSearchSchema.DocumentPropertyConfig.Builder AddIndexableNestedProperties(params string[] indexableNestedProperties);
[<Android.Runtime.Register("addIndexableNestedProperties", "([Ljava/lang/String;)Landroid/app/appsearch/AppSearchSchema$DocumentPropertyConfig$Builder;", "", ApiSince=35)>]
member this.AddIndexableNestedProperties : string[] -> Android.App.AppSearch.AppSearchSchema.DocumentPropertyConfig.Builder

Parameters

indexableNestedProperties
String[]

Returns

Attributes

Remarks

Adds one or more properties for indexing from the nested document property.

Android reference for android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder.addIndexableNestedProperties.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to