# AppSearchSchema.DocumentPropertyConfig

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/app/AppSearchSchema.java+class:androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
class AppSearchSchema.DocumentPropertyConfig : AppSearchSchema.PropertyConfig
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.appsearch.app.AppSearchSchema.PropertyConfig](https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig) ||
|   | ↳ | [androidx.appsearch.app.AppSearchSchema.DocumentPropertyConfig](https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig) |

*** ** * ** ***

Configuration for a property containing another Document.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig`. |

| ### Public functions |
|---|---|
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = https://developer.android.com/reference/kotlin/androidx/appsearch/app/Features.SCHEMA_GET_INDEXABLE_NESTED_PROPERTIES) https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig#getIndexableNestedProperties()()` Returns the list of indexable nested properties for the nested document. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig#getSchemaType()()` Returns the logical schema-type of the contents of this document property. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig#shouldIndexNestedProperties()()` Returns whether properties in the nested document should be indexed according to that document's schema. |

| ### Inherited Constants |
|---|
| From [androidx.appsearch.app.AppSearchSchema.PropertyConfig](https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig) |---|---| | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL() = 2` Zero or one value \[0,1\]. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED() = 1` Any number of items (including zero) \[0...\*\]. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED() = 3` Exactly one value \[1\]. | |

| ### Inherited functions |
|---|
| From [androidx.appsearch.app.AppSearchSchema.PropertyConfig](https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig) |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#equals(java.lang.Object)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#getCardinality()()` Returns the cardinality of the property (whether it is optional, required or repeated). | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#getDescription()()` Returns a natural language description of this property. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#getName()()` Returns the name of this property. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#hashCode()()` | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#toString()()` | |

## Public functions

### getIndexableNestedProperties

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_GET_INDEXABLE_NESTED_PROPERTIES)
fun getIndexableNestedProperties(): (Mutable)List<String!>
```

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

### getSchemaType

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun getSchemaType(): String
```

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

### shouldIndexNestedProperties

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun shouldIndexNestedProperties(): Boolean
```

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.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.DocumentPropertyConfig.Builder#addIndexableNestedProperties(java.util.Collection<java.lang.String>)` | for indexing a subset of properties from the nested document. |