# AppSearchSchema.PropertyConfig
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Constants](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#constants)\|[Methods](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#inhmethods)
# AppSearchSchema.PropertyConfig
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSchema.PropertyConfig "View this page in Kotlin")\|Java
`
public
static
abstract
class
AppSearchSchema.PropertyConfig
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
`
|---|------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appsearch.AppSearchSchema.PropertyConfig |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known direct subclasses [AppSearchSchema.BlobHandlePropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BlobHandlePropertyConfig),[AppSearchSchema.BooleanPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BooleanPropertyConfig),[AppSearchSchema.BytesPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BytesPropertyConfig),[AppSearchSchema.DocumentPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.DocumentPropertyConfig),[AppSearchSchema.DoublePropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.DoublePropertyConfig),[AppSearchSchema.EmbeddingPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig),[AppSearchSchema.LongPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.LongPropertyConfig),[AppSearchSchema.StringPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.StringPropertyConfig) |----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | [AppSearchSchema.BlobHandlePropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BlobHandlePropertyConfig) | Configuration for a property of type[AppSearchBlobHandle](https://developer.android.com/reference/android/app/appsearch/AppSearchBlobHandle)in a Document. | | [AppSearchSchema.BooleanPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BooleanPropertyConfig) | Configuration for a property containing a boolean. | | [AppSearchSchema.BytesPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.BytesPropertyConfig) | Configuration for a property containing a byte array. | | [AppSearchSchema.DocumentPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.DocumentPropertyConfig) | Configuration for a property containing another Document. | | [AppSearchSchema.DoublePropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.DoublePropertyConfig) | Configuration for a property containing a double-precision decimal number. | | [AppSearchSchema.EmbeddingPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.EmbeddingPropertyConfig) | Configuration for a property of type[EmbeddingVector](https://developer.android.com/reference/android/app/appsearch/EmbeddingVector)in a Document. | | [AppSearchSchema.LongPropertyConfig](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.LongPropertyConfig) | Configuration for a property containing a 64-bit integer. | | [AppSearchSchema.StringPropertyConfig](https://developer.android.com/reference/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 ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [CARDINALITY_OPTIONAL](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL) Zero or one value \[0,1\]. |
| `int` | [CARDINALITY_REPEATED](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED) Any number of items (including zero) \[0...\*\]. |
| `int` | [CARDINALITY_REQUIRED](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED) Exactly one value \[1\]. |
| ### Public methods ||
|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean` | ` `[equals](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` other) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` `[getCardinality](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#getCardinality())`() ` Returns the cardinality of the property (whether it is optional, required or repeated). |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getDescription](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#getDescription())`() ` Returns a natural language description of this property. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getName](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#getName())`() ` Returns the name of this property. |
| ` int` | ` `[hashCode](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#hashCode())`() ` Returns a hash code value for the object. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#toString())`() ` Returns a string representation of the object. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
## Constants
### CARDINALITY_OPTIONAL
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int CARDINALITY_OPTIONAL
```
Zero or one value \[0,1\].
Constant Value: 2 (0x00000002)
### CARDINALITY_REPEATED
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int CARDINALITY_REPEATED
```
Any number of items (including zero) \[0...\*\].
Constant Value: 1 (0x00000001)
### CARDINALITY_REQUIRED
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int CARDINALITY_REQUIRED
```
Exactly one value \[1\].
Constant Value: 3 (0x00000003)
## Public methods
### equals
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean equals (Object other)
```
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 ||
|---------|-------------------------------------------|
| `other` | `Object`: This value may be`null`.
|
| Returns ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `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#ApiLevels)
```
public int getCardinality ()
```
Returns the cardinality of the property (whether it is optional, required or repeated).
| Returns ||
|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is[CARDINALITY_REPEATED](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED),[CARDINALITY_OPTIONAL](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL), or[CARDINALITY_REQUIRED](https://developer.android.com/reference/android/app/appsearch/AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED)
|
### getDescription
Added in[version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)
Also in[T Extensions 18](https://developer.android.com/sdkExtensions)
```
public String getDescription ()
```
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.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### getName
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getName ()
```
Returns the name of this property.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### hashCode
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int hashCode ()
```
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap).
The general contract of`hashCode`is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce the same integer result.
- It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object.
|
### toString
Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|