SetSchemaResponse

fun getDeletedTypes(): (Mutable)Set<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 setSchemaAsync call.

Documents for a deleted type are removed from the database.

fun getIncompatibleTypes(): (Mutable)Set<String!>

Returns a Set of schema type whose new definitions set in the setSchemaAsync 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.

fun getMigratedTypes(): (Mutable)Set<String!>

Returns a Set of schema type that were migrated by the setSchemaAsync 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.

fun getMigrationFailures(): (Mutable)List<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.