AppSearchResult

@ExperimentalAppSearchApi
public static final int RESULT_ALREADY_EXISTS = 12

The operation is invalid because the resource already exists and can't be replaced.

@ExperimentalAppSearchApi
public static final int RESULT_DENIED = 9

The requested operation is denied for the caller. This error is logged and returned for denylist rejections.

public static final int RESULT_INTERNAL_ERROR = 2

An internal error occurred within AppSearch, which the caller cannot address. This error may be considered similar to IllegalStateException

public static final int RESULT_INVALID_ARGUMENT = 3

The caller supplied invalid arguments to the call. This error may be considered similar to IllegalArgumentException.

public static final int RESULT_INVALID_SCHEMA = 7

The caller supplied a schema which is invalid or incompatible with the previous schema.

public static final int RESULT_IO_ERROR = 4

An issue occurred reading or writing to storage. The call might succeed if repeated. This error may be considered similar to java.io.IOException.

public static final int RESULT_NOT_FOUND = 6

An entity the caller requested to interact with does not exist in the system.

public static final int RESULT_OK = 0

The call was successful.

public static final int RESULT_OUT_OF_SPACE = 5

Storage is out of space, and no more space could be reclaimed.

@ExperimentalAppSearchApi
public static final int RESULT_RATE_LIMITED = 10

The caller has hit AppSearch's rate limit and the requested operation has been rejected. The caller is recommended to reschedule tasks with exponential backoff.

public static final int RESULT_SECURITY_ERROR = 8

The caller requested an operation it does not have privileges for.

@ExperimentalAppSearchApi
public static final int RESULT_TIMED_OUT = 11

The operation was timed out.

public static final int RESULT_UNKNOWN_ERROR = 1

An unknown error occurred while processing the call.

public @Nullable String getErrorMessage()

Returns the error message associated with this result.

If isSuccess is true, the error message is always null. The error message may be null even if isSuccess is false. See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is returned by getErrorMessage.

public int getResultCode()

Returns one of the RESULT constants defined in AppSearchResult.

public @Nullable ValueType getResultValue()

Returns the result value associated with this result, if it was successful.

See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is placed in the result value by that call.

public boolean isSuccess()

Returns true if getResultCode equals RESULT_OK.

public static @NonNull AppSearchResult<ValueType> <ValueType> newFailedResult(int resultCode, @Nullable String errorMessage)

Creates a new failed AppSearchResult.

public static @NonNull AppSearchResult<ValueType> <ValueType> newSuccessfulResult(@Nullable ValueType value)

Creates a new successful AppSearchResult.