Added in API level 31

SetSchemaResponse

class SetSchemaResponse : Parcelable
kotlin.Any
   ↳ android.app.appsearch.SetSchemaResponse

The response class of AppSearchSession#setSchema

Summary

Nested classes

Builder for SetSchemaResponse objects.

The class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession#setSchema.
Inherited constants
Public methods
MutableSet<String!>

Returns a Set of deleted schema types.
MutableSet<String!>

Returns a Set of schema type whose new definitions set in the android.app.appsearch.AppSearchSession#setSchema call were incompatible with the pre-existing schema.
MutableSet<String!>

Returns a Set of schema type that were migrated by the android.app.appsearch.AppSearchSession#setSchema call.
MutableList<SetSchemaResponse.MigrationFailure!>

Returns a List of all failed MigrationFailure.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<SetSchemaResponse!>

Public methods

getDeletedTypes

Added in API level 31
fun getDeletedTypes(): MutableSet<String!>

Returns a Set of deleted schema types.

A "deleted" type is a schema type that was previously a part of the database schema but was not present in the SetSchemaRequest object provided in the android.app.appsearch.AppSearchSession#setSchema call.

Documents for a deleted type are removed from the database.

Return
MutableSet<String!> This value cannot be null.

getIncompatibleTypes

Added in API level 31
fun getIncompatibleTypes(): MutableSet<String!>

Returns a Set of schema type whose new definitions set in the android.app.appsearch.AppSearchSession#setSchema call were incompatible with the pre-existing schema.

If a Migrator is provided for this type and the migration is success triggered. The type will also appear in getMigratedTypes().

Return
MutableSet<String!> This value cannot be null.

getMigratedTypes

Added in API level 31
fun getMigratedTypes(): MutableSet<String!>

Returns a Set of schema type that were migrated by the android.app.appsearch.AppSearchSession#setSchema call.

A "migrated" type is a schema type that has triggered a Migrator instance to migrate documents of the schema type to another schema type, or to another version of the schema type.

If a document fails to be migrated, a MigrationFailure will be generated for that document.

Return
MutableSet<String!> This value cannot be null.

getMigrationFailures

Added in API level 31
fun getMigrationFailures(): MutableList<SetSchemaResponse.MigrationFailure!>

Returns a List of all failed MigrationFailure.

A MigrationFailure will be generated if the system trying to save a post-migrated GenericDocument but fail.

MigrationFailure contains the namespace, id and schemaType of the post-migrated GenericDocument and the error reason. Mostly it will be mismatch the schema it migrated to.

Return
MutableList<SetSchemaResponse.MigrationFailure!> This value cannot be null.

writeToParcel

Added in API level 35
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35
static val CREATOR: Parcelable.Creator<SetSchemaResponse!>