# AppSearchSchema.PropertyConfig

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# PropertyConfig

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig "View this page in Java")  

```
abstract class PropertyConfig
```

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

|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known Direct Subclasses [AppSearchSchema.BlobHandlePropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BlobHandlePropertyConfig),[AppSearchSchema.BooleanPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BooleanPropertyConfig),[AppSearchSchema.BytesPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BytesPropertyConfig),[AppSearchSchema.DocumentPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.DocumentPropertyConfig),[AppSearchSchema.DoublePropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.DoublePropertyConfig),[AppSearchSchema.EmbeddingPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig),[AppSearchSchema.LongPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.LongPropertyConfig),[AppSearchSchema.StringPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.StringPropertyConfig) |-----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [AppSearchSchema.BlobHandlePropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BlobHandlePropertyConfig) | Configuration for a property of type[AppSearchBlobHandle](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchBlobHandle)in a Document. | | [AppSearchSchema.BooleanPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BooleanPropertyConfig)       | Configuration for a property containing a boolean.                                                                                                                | | [AppSearchSchema.BytesPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.BytesPropertyConfig)           | Configuration for a property containing a byte array.                                                                                                             | | [AppSearchSchema.DocumentPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.DocumentPropertyConfig)     | Configuration for a property containing another Document.                                                                                                         | | [AppSearchSchema.DoublePropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.DoublePropertyConfig)         | Configuration for a property containing a double-precision decimal number.                                                                                        | | [AppSearchSchema.EmbeddingPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig)   | Configuration for a property of type[EmbeddingVector](https://developer.android.com/reference/kotlin/android/app/appsearch/EmbeddingVector)in a Document.         | | [AppSearchSchema.LongPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.LongPropertyConfig)             | Configuration for a property containing a 64-bit integer.                                                                                                         | | [AppSearchSchema.StringPropertyConfig](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.StringPropertyConfig)         | Configuration for a property of type String in a Document.                                                                                                        | |

Common configuration for a single property (field) in a Document.

For example, an`EmailMessage`would be a type and the`subject`would be a property.

## Summary

|                                                                                                                                        Constants                                                                                                                                        ||
|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_OPTIONAL](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL:kotlin.Int) Zero or one value \[0,1\].                |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_REPEATED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED:kotlin.Int) Any number of items (including zero) \[0. |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CARDINALITY_REQUIRED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED:kotlin.Int) Exactly one value \[1\].                  |

|                                                                                                                                                                                 Public methods                                                                                                                                                                                 ||
|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| open[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one. |
| open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)         | [getCardinality](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getCardinality())`()` Returns the cardinality of the property (whether it is optional, required or repeated).                                                     |
| open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)   | [getDescription](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getDescription())`()` Returns a natural language description of this property.                                                                                    |
| open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)   | [getName](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#getName())`()` Returns the name of this property.                                                                                                                        |
| open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)         | [hashCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#hashCode())`()` <br />                                                                                                                                                  |
| open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)   | [toString](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#toString())`()` Returns a string representation of the object.                                                                                                          |

## Constants

### CARDINALITY_OPTIONAL

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CARDINALITY_OPTIONAL: Int
```

Zero or one value \[0,1\].  

    Value: 2

### CARDINALITY_REPEATED

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CARDINALITY_REPEATED: Int
```

Any number of items (including zero) \[0...\*\].  

    Value: 1

### CARDINALITY_REQUIRED

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CARDINALITY_REQUIRED: Int
```

Exactly one value \[1\].  

    Value: 3

## Public methods

### equals

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The`equals`method implements an equivalence relation on non-null object references:

- It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`.
- It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`.
- It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`.
- It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified.
- For any non-null reference value`x`,`x.equals(null)`should return`false`.

An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

|                                                  Parameters                                                   ||
|---------|------------------------------------------------------------------------------------------------------|
| `obj`   | the reference object with which to compare.                                                          |
| `other` | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?:This value may be`null`. |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### getCardinality

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun getCardinality(): Int
```

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

|                                                                                                                                                                                                                                                                                                                                                                  Return                                                                                                                                                                                                                                                                                                                                                                   ||
|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Value is[android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED:kotlin.Int),[android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL:kotlin.Int), or[android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED:kotlin.Int) |

### getDescription

Added in[API level 36.1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  
Also in[T Extensions 18](https://developer.android.com/sdkExtensions)  

```
open fun getDescription(): String
```

Returns a natural language description of this property.

Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives".

This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.

|                                                    Return                                                     ||
|----------------------------------------------------------------------------------|-----------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | This value cannot be`null`. |

### getName

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun getName(): String
```

Returns the name of this property.

|                                                    Return                                                     ||
|----------------------------------------------------------------------------------|-----------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | This value cannot be`null`. |

### hashCode

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun hashCode(): Int
```

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun toString(): String
```

Returns a string representation of the object.

|                                                    Return                                                     ||
|----------------------------------------------------------------------------------|-----------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | This value cannot be`null`. |