Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#nestedclasses) \| [Constants](https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#constants) \| [Methods](https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#inhmethods)

# SetSchemaRequest

*** ** * ** ***


`
public

final

class
SetSchemaRequest
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appsearch.SetSchemaRequest |

<br />

*** ** * ** ***

Encapsulates a request to update the schema of an `https://developer.android.com/reference/android/app/appsearch/AppSearchSession` database.

The schema is composed of a collection of `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` objects, each of which
defines a unique type of data.

The first call to SetSchemaRequest will set the provided schema and store it within the `https://developer.android.com/reference/android/app/appsearch/AppSearchSession` database.

Subsequent calls will compare the provided schema to the previously saved schema, to determine
how to treat existing documents.

The following types of schema modifications are always safe and are made without deleting any
existing documents:

- Addition of new `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` types
- Addition of new properties to an existing `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` type
- Changing the cardinality of a property to be less restrictive

The following types of schema changes are not backwards compatible:

- Removal of an existing `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` type
- Removal of a property from an existing `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` type
- Changing the data type of an existing property
- Changing the cardinality of a property to be more restrictive

Providing a schema with incompatible changes, will throw an `https://developer.android.com/reference/android/app/appsearch/exceptions/AppSearchException`, with a message describing the
incompatibility. As a result, the previously set schema will remain unchanged.

Backward incompatible changes can be made by :

- setting `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#setForceOverride(boolean)` method to `true`. This deletes all documents that are incompatible with the new schema. The new schema is then saved and persisted to disk.
- Add a `https://developer.android.com/reference/android/app/appsearch/Migrator` for each incompatible type and make no deletion. The migrator will migrate documents from its old schema version to the new version. Migrated types will be set into both `https://developer.android.com/reference/android/app/appsearch/SetSchemaResponse#getIncompatibleTypes()` and `https://developer.android.com/reference/android/app/appsearch/SetSchemaResponse#getMigratedTypes()`. See the migration section below.

<br />

**See also:**

- `https://developer.android.com/reference/android/app/appsearch/AppSearchSession#setSchema(android.app.appsearch.SetSchemaRequest,%20java.util.concurrent.Executor,%20java.util.concurrent.Executor,%20java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.SetSchemaResponse>>)`
- `https://developer.android.com/reference/android/app/appsearch/Migrator`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder` Builder for `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest` objects. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#PRIVATE_COMPUTE_CORE_UID_ACCESS` The visibility access for Private Compute Core. |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_ASSISTANT_APP_SEARCH_DATA` The `https://developer.android.com/reference/android/Manifest.permission#READ_ASSISTANT_APP_SEARCH_DATA` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_CALENDAR` The `https://developer.android.com/reference/android/Manifest.permission#READ_CALENDAR` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_CONTACTS` The `https://developer.android.com/reference/android/Manifest.permission#READ_CONTACTS` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_EXTERNAL_STORAGE` The `https://developer.android.com/reference/android/Manifest.permission#READ_EXTERNAL_STORAGE` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_HOME_APP_SEARCH_DATA` The `https://developer.android.com/reference/android/Manifest.permission#READ_HOME_APP_SEARCH_DATA` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |
| `int` | `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_SMS` The `https://developer.android.com/reference/android/Manifest.permission#READ_SMS` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)` |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/android/app/appsearch/Migrator>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getMigrators()() ` Returns the map of `https://developer.android.com/reference/android/app/appsearch/Migrator`, the key will be the schema type of the `https://developer.android.com/reference/android/app/appsearch/Migrator` associated with. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/android/app/appsearch/PackageIdentifier>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getPubliclyVisibleSchemas()() ` Returns a mapping of publicly visible schemas to the `https://developer.android.com/reference/android/app/appsearch/PackageIdentifier` specifying the package the schemas are from. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/Integer>>>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getRequiredPermissionsForSchemaTypeVisibility()() ` Returns a mapping of schema types to the Map of `https://developer.android.com/reference/android/Manifest.permission` combinations that querier must hold to access that schema type. |
| ` https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/AppSearchSchema>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getSchemas()() ` Returns the `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` types that are part of this request. |
| ` https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getSchemasNotDisplayedBySystem()() ` Returns all the schema types that are opted out of being displayed and visible on any system UI surface. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/SchemaVisibilityConfig>>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getSchemasVisibleToConfigs()() ` Returns a mapping of schema types to the set of `https://developer.android.com/reference/android/app/appsearch/SchemaVisibilityConfig` that have access to that schema type. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/PackageIdentifier>>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getSchemasVisibleToPackages()() ` Returns a mapping of schema types to the set of packages that have access to that schema type. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/String>>` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getSchemasWipeoutAccountPropertyPaths()() ` Returns a map containing all schema types that have been configured for account wipeout, mapped to the specific property paths within those schemas that hold the account identifiers. |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#getVersion()() ` Returns the database overall schema version. |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#isForceOverride()() ` Returns whether this request will force the schema to be overridden. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` 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 https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` 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` | ` 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` | ` 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

### PRIVATE_COMPUTE_CORE_UID_ACCESS

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

```
public static final int PRIVATE_COMPUTE_CORE_UID_ACCESS
```

The visibility access for Private Compute Core.

A schema with this permission requires callers to have a UID for which `https://developer.android.com/reference/android/os/Process#isPrivateComputeCoreUid(int)` returns true to access the data.

This permission can be combined with other permissions in the same set. In such cases, the
caller must both have a Private Compute Core UID and hold all other permissions in the set to
gain access.

<br />

Constant Value:

12
(0x0000000c)


### READ_ASSISTANT_APP_SEARCH_DATA

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

```
public static final int READ_ASSISTANT_APP_SEARCH_DATA
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_ASSISTANT_APP_SEARCH_DATA` AppSearch supported in
`https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

6
(0x00000006)


### READ_CALENDAR

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

```
public static final int READ_CALENDAR
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_CALENDAR` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

2
(0x00000002)


### READ_CONTACTS

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

```
public static final int READ_CONTACTS
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_CONTACTS` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

3
(0x00000003)


### READ_EXTERNAL_STORAGE

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

```
public static final int READ_EXTERNAL_STORAGE
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_EXTERNAL_STORAGE` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

4
(0x00000004)


### READ_HOME_APP_SEARCH_DATA

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

```
public static final int READ_HOME_APP_SEARCH_DATA
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_HOME_APP_SEARCH_DATA` AppSearch supported in
`https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

5
(0x00000005)


### READ_SMS

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

```
public static final int READ_SMS
```

The `https://developer.android.com/reference/android/Manifest.permission#READ_SMS` AppSearch supported in `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addRequiredPermissionsForSchemaTypeVisibility(java.lang.String,%20java.util.Set<java.lang.Integer>)`

<br />

Constant Value:

1
(0x00000001)


## 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.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getMigrators

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

```
public Map<String, Migrator> getMigrators ()
```

Returns the map of `https://developer.android.com/reference/android/app/appsearch/Migrator`, the key will be the schema type of the `https://developer.android.com/reference/android/app/appsearch/Migrator`
associated with.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/android/app/appsearch/Migrator>` | This value cannot be `null`. <br /> |

### getPubliclyVisibleSchemas

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

```
public Map<String, PackageIdentifier> getPubliclyVisibleSchemas ()
```

Returns a mapping of publicly visible schemas to the `https://developer.android.com/reference/android/app/appsearch/PackageIdentifier` specifying the
package the schemas are from.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/android/app/appsearch/PackageIdentifier>` | This value cannot be `null`. <br /> |

### getRequiredPermissionsForSchemaTypeVisibility

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

```
public Map<String, Set<Set<Integer>>> getRequiredPermissionsForSchemaTypeVisibility ()
```

Returns a mapping of schema types to the Map of `https://developer.android.com/reference/android/Manifest.permission`
combinations that querier must hold to access that schema type.

The querier could read the `https://developer.android.com/reference/android/app/appsearch/GenericDocument` objects under the `schemaType` if
they holds ALL required permissions of ANY of the individual value sets.

For example, if the Map contains `{{permissionA, PermissionB},
{PermissionC, PermissionD}, {PermissionE}}`.

- A querier holds both PermissionA and PermissionB has access.
- A querier holds both PermissionC and PermissionD has access.
- A querier holds only PermissionE has access.
- A querier holds both PermissionA and PermissionE has access.
- A querier holds only PermissionA doesn't have access.
- A querier holds both PermissionA and PermissionC doesn't have access.

It\\u2019s inefficient to call this method repeatedly.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/Integer>>>` | The map contains schema type and all combinations of required permission for querier to access it. The supported Permission are `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_SMS`, `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_CALENDAR`, `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_CONTACTS`, `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_EXTERNAL_STORAGE`, `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_HOME_APP_SEARCH_DATA` and `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest#READ_ASSISTANT_APP_SEARCH_DATA`. This value cannot be `null`. <br /> |

### getSchemas

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

```
public Set<AppSearchSchema> getSchemas ()
```

Returns the `https://developer.android.com/reference/android/app/appsearch/AppSearchSchema` types that are part of this request.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/AppSearchSchema>` | This value cannot be `null`. <br /> |

### getSchemasNotDisplayedBySystem

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

```
public Set<String> getSchemasNotDisplayedBySystem ()
```

Returns all the schema types that are opted out of being displayed and visible on any system
UI surface.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/String>` | This value cannot be `null`. <br /> |

### getSchemasVisibleToConfigs

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

```
public Map<String, Set<SchemaVisibilityConfig>> getSchemasVisibleToConfigs ()
```

Returns a mapping of schema types to the set of `https://developer.android.com/reference/android/app/appsearch/SchemaVisibilityConfig` that have
access to that schema type.

It\\u2019s inefficient to call this method repeatedly.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/SchemaVisibilityConfig>>` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/app/appsearch/SetSchemaRequest.Builder#addSchemaTypeVisibleToConfig(java.lang.String,%20android.app.appsearch.SchemaVisibilityConfig)`

### getSchemasVisibleToPackages

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

```
public Map<String, Set<PackageIdentifier>> getSchemasVisibleToPackages ()
```

Returns a mapping of schema types to the set of packages that have access to that schema
type.

It\\u2019s inefficient to call this method repeatedly.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/android/app/appsearch/PackageIdentifier>>` | This value cannot be `null`. <br /> |

### getSchemasWipeoutAccountPropertyPaths

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

```
public Map<String, Set<String>> getSchemasWipeoutAccountPropertyPaths ()
```

Returns a map containing all schema types that have been configured for account wipeout,
mapped to the specific property paths within those schemas that hold the account identifiers.

This method performs a deep copy to ensure the returned map and its contained sets are
immutable from external modifications.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/java/lang/String, https://developer.android.com/reference/java/util/Set<https://developer.android.com/reference/java/lang/String>>` | A map where keys are schema type names, and values are sets of `https://developer.android.com/reference/android/app/appsearch/PropertyPath` strings configured for account wipeout for that schema type. This value cannot be `null`. <br /> |

### getVersion

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

```
public int getVersion ()
```

Returns the database overall schema version.

<br />

| Returns ||
|---|---|
| `int` | Value is 1 or greater <br /> |

### 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
`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 `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 `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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isForceOverride

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

```
public boolean isForceOverride ()
```

Returns whether this request will force the schema to be overridden.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |