Summary: Nested Classes | Methods | Inherited Methods

SetSchemaRequest

Kotlin |Java

public final class SetSchemaRequest
extends Object

java.lang.Object
↳	android.app.appsearch.SetSchemaRequest

Encapsulates a request to update the schema of an AppSearchSession database.

The schema is composed of a collection of 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 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 AppSearchSchema types
Addition of new properties to an existing 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 AppSearchSchema type
Removal of a property from an existing 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 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 SetSchemaRequest.Builder#setForceOverride 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 Migrator for each incompatible type and make no deletion. The migrator will migrate documents from it's old schema version to the new version. Migrated types will be set into both SetSchemaResponse#getIncompatibleTypes() and SetSchemaResponse.getMigratedTypes(). See the migration section below.

See also:

Summary

Nested classes
`class`	`SetSchemaRequest.Builder` Builder for `SetSchemaRequest` objects.

Public methods
`Map<String, Migrator>`	`getMigrators()` Returns the map of `Migrator`, the key will be the schema type of the `Migrator` associated with.
`Set<AppSearchSchema>`	`getSchemas()` Returns the `AppSearchSchema` types that are part of this request.
`Set<String>`	`getSchemasNotDisplayedBySystem()` Returns all the schema types that are opted out of being displayed and visible on any system UI surface.
`Map<String, Set<PackageIdentifier>>`	`getSchemasVisibleToPackages()` Returns a mapping of schema types to the set of packages that have access to that schema type.
`int`	`getVersion()` Returns the database overall schema version.
`boolean`	`isForceOverride()` Returns whether this request will force the schema to be overridden.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

getMigrators

Added in Android S

public Map<String, Migrator> getMigrators ()

Returns the map of Migrator, the key will be the schema type of the Migrator associated with.

Returns
`Map<String, Migrator>`	This value cannot be `null`.

getSchemas

Added in Android S

public Set<AppSearchSchema> getSchemas ()

Returns the AppSearchSchema types that are part of this request.

Returns
`Set<AppSearchSchema>`	This value cannot be `null`.

getSchemasNotDisplayedBySystem

Added in Android S

public Set<String> getSchemasNotDisplayedBySystem ()

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

Returns
`Set<String>`	This value cannot be `null`.

getSchemasVisibleToPackages

Added in Android S

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’s inefficient to call this method repeatedly.

Returns
`Map<String, Set<PackageIdentifier>>`	This value cannot be `null`.

getVersion

Added in Android S

public int getVersion ()

Returns the database overall schema version.

Returns
`int`	Value is 1 or greater

isForceOverride

Added in Android S

public boolean isForceOverride ()

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

Returns
`boolean`

SetSchemaRequest

Summary

Nested classes

Public methods

Inherited methods

Public methods

getMigrators

getSchemas

getSchemasNotDisplayedBySystem

getSchemasVisibleToPackages

getVersion

isForceOverride