SetSchemaResponse.MigrationFailure

public static class SetSchemaResponse.MigrationFailure
extends Object implements Parcelable

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


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

Summary

Inherited constants

Fields

public static final Creator<SetSchemaResponse.MigrationFailure> CREATOR

Public constructors

MigrationFailure(String namespace, String documentId, String schemaType, AppSearchResult<?> failedResult)

Constructs a new MigrationFailure.

Public methods

AppSearchResult<Void> getAppSearchResult()

Returns the AppSearchResult that indicates why the post-migration GenericDocument failed to be indexed.

String getDocumentId()

Returns the id of the GenericDocument that failed to be migrated.

String getNamespace()

Returns the namespace of the GenericDocument that failed to be migrated.

String getSchemaType()

Returns the schema type of the GenericDocument that failed to be migrated.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

Public constructors

MigrationFailure

Added in API level 31
public MigrationFailure (String namespace, 
                String documentId, 
                String schemaType, 
                AppSearchResult<?> failedResult)

Constructs a new MigrationFailure.

Parameters
namespace String: The namespace of the document which failed to be migrated. This value cannot be null.

documentId String: The id of the document which failed to be migrated. This value cannot be null.

schemaType String: The type of the document which failed to be migrated. This value cannot be null.

failedResult AppSearchResult: The reason why the document failed to be indexed. This value cannot be null.

Throws
IllegalArgumentException if the provided failedResult was not a failure.

Public methods

getAppSearchResult

Added in API level 31
public AppSearchResult<Void> getAppSearchResult ()

Returns the AppSearchResult that indicates why the post-migration GenericDocument failed to be indexed.

Returns
AppSearchResult<Void> This value cannot be null.

getDocumentId

Added in API level 31
public String getDocumentId ()

Returns the id of the GenericDocument that failed to be migrated.

Returns
String This value cannot be null.

getNamespace

Added in API level 31
public String getNamespace ()

Returns the namespace of the GenericDocument that failed to be migrated.

Returns
String This value cannot be null.

getSchemaType

Added in API level 31
public String getSchemaType ()

Returns the schema type of the GenericDocument that failed to be migrated.

Returns
String This value cannot be null.

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String 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