SetSchemaResponse.MigrationFailure

Kotlin |Java

class SetSchemaResponse.MigrationFailure

The class represents a post-migrated GenericDocument that failed to be saved by setSchemaAsync.

Summary

Public constructors
`MigrationFailure( namespace: String, documentId: String, schemaType: String, failedResult: AppSearchResult<Any!> )` Constructs a new `MigrationFailure`.

Public functions
`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()`

MigrationFailure(
    namespace: String,
    documentId: String,
    schemaType: String,
    failedResult: AppSearchResult<Any!>
)

Constructs a new MigrationFailure.

Parameters
`namespace: String`	The namespace of the document which failed to be migrated.
`documentId: String`	The id of the document which failed to be migrated.
`schemaType: String`	The type of the document which failed to be migrated.
`failedResult: AppSearchResult<Any!>`	The reason why the document failed to be indexed.

Throws
`java.lang.IllegalArgumentException`	if the provided `failedResult` was not a failure.

fun getAppSearchResult(): AppSearchResult<Void!>

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

fun getDocumentId(): String

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

fun getNamespace(): String

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

fun getSchemaType(): String

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

fun toString(): String