SetSchemaResponse.MigrationFailure

Page Summary

• SetSchemaResponse.MigrationFailure represents a GenericDocument that failed to be saved after migration when setting the schema.

• It implements the Parcelable interface.

• Key information available includes the namespace, document ID, schema type, and the AppSearchResult indicating the reason for the failure.

public static class SetSchemaResponse.MigrationFailure extends Object
implements Parcelable

The class represents a post-migrated GenericDocument that failed to be saved by AppSearchClient.setSchema(SetSchemaRequest, String).

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<SetSchemaResponse.MigrationFailure>

CREATOR

Public Constructor Summary

MigrationFailure(String namespace, String documentId, String schemaType, AppSearchResult<?> failedResult) Constructs a new SetSchemaResponse.MigrationFailure.

Public Method Summary

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()
void	writeToParcel(Parcel dest, int flags)

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Fields

public static final Creator<SetSchemaResponse.MigrationFailure> CREATOR

Public Constructors

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

Constructs a new SetSchemaResponse.MigrationFailure.

Parameters

namespace	The namespace of the document which failed to be migrated.
documentId	The id of the document which failed to be migrated.
schemaType	The type of the document which failed to be migrated.
failedResult	The reason why the document failed to be indexed.

Throws

IllegalArgumentException	if the provided failedResult was not a failure.

Public Methods

public AppSearchResult<Void> getAppSearchResult ()

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

public String getDocumentId ()

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

public String getNamespace ()

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

public String getSchemaType ()

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

public String toString ()

public void writeToParcel (Parcel dest, int flags)