# Print output for @column tags ?> SetSchemaResponse - Android SDK | Android Developers

Most visited

Recently visited

SetSchemaResponse

public class SetSchemaResponse
extends Object

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


The response class of AppSearchSession#setSchema

Summary

Nested classes

class SetSchemaResponse.Builder

Builder for SetSchemaResponse objects. 

class SetSchemaResponse.MigrationFailure

The class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession#setSchema

Public methods

Set<String> getDeletedTypes()

Returns a Set of deleted schema types.

Set<String> getIncompatibleTypes()

Returns a Set of schema type whose new definitions set in the AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer>) call were incompatible with the pre-existing schema.

Set<String> getMigratedTypes()

Returns a Set of schema type that were migrated by the AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer>) call.

List<SetSchemaResponse.MigrationFailure> getMigrationFailures()

Returns a List of all failed MigrationFailure.

Inherited methods

Public methods

getDeletedTypes

public Set<String> getDeletedTypes ()

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 AppSearchSession#setSchema

Returns
Set<String>

getIncompatibleTypes

public Set<String> getIncompatibleTypes ()

Returns a Set of schema type whose new definitions set in the AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer>) 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().

Returns
Set<String> This value cannot be null.

See also:

getMigratedTypes

public Set<String> getMigratedTypes ()

Returns a Set of schema type that were migrated by the AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer>) 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.

Returns
Set<String> This value cannot be null.

See also:

getMigrationFailures

public List<SetSchemaResponse.MigrationFailure> getMigrationFailures ()

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.

Returns
List<SetSchemaResponse.MigrationFailure> This value cannot be null.