SetSchemaResponse.MigrationFailure

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

Field Summary

public static final Creator<SetSchemaResponse.MigrationFailure> CREATOR

Public Constructor Summary

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

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

Inherited Method Summary

Fields

public static final Creator<SetSchemaResponse.MigrationFailure> CREATOR

Public Constructors

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

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)