SetSchemaResponse
public
final
class
SetSchemaResponse
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.appsearch.SetSchemaResponse |
The response class of AppSearchSession#setSchema
Summary
Nested classes | |
---|---|
class |
SetSchemaResponse.Builder
Builder for |
class |
SetSchemaResponse.MigrationFailure
The class represents a post-migrated |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<SetSchemaResponse> |
CREATOR
|
Public methods | |
---|---|
Set<String>
|
getDeletedTypes()
Returns a |
Set<String>
|
getIncompatibleTypes()
Returns a |
Set<String>
|
getMigratedTypes()
Returns a |
List<SetSchemaResponse.MigrationFailure>
|
getMigrationFailures()
Returns a |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
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(SetSchemaRequest, Executor, Executor, Consumer)
call.
Documents for a deleted type are removed from the database.
Returns | |
---|---|
Set<String> |
This value cannot be null . |
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 . |
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 . |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.