Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SetSchemaResponse

---

Kotlin |Java

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 SetSchemaResponse objects.
class	SetSchemaResponse.MigrationFailure The class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession.setSchema.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<SetSchemaResponse>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
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 call were incompatible with the pre-existing schema.
Set<String>	getMigratedTypes() Returns a Set of schema type that were migrated by the AppSearchSession.setSchema call.
List<SetSchemaResponse.MigrationFailure>	getMigrationFailures() Returns a List of all failed MigrationFailure.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in T Extensions 13

public static final Creator<SetSchemaResponse> CREATOR

Public methods

describeContents

Added in API level 35

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getDeletedTypes

Added in API level 31

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 call.

Documents for a deleted type are removed from the database.

Returns
Set<String>	This value cannot be null.

getIncompatibleTypes

Added in API level 31

public Set<String> getIncompatibleTypes ()

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

Returns
Set<String>	This value cannot be null.

See also:

• SetSchemaRequest
• AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer)
• SetSchemaRequest.Builder.setForceOverride(boolean)

getMigratedTypes

Added in API level 31

public Set<String> getMigratedTypes ()

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

Returns
Set<String>	This value cannot be null.

See also:

• Migrator

getMigrationFailures

Added in API level 31

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

Added in API level 35

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 the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE