AppSearchResult

RESULT_DENIED

public static final int RESULT_DENIED

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

Constant Value: 9 (0x00000009)

RESULT_INTERNAL_ERROR

public static final int RESULT_INTERNAL_ERROR

An internal error occurred within AppSearch, which the caller cannot address.

This error may be considered similar to IllegalStateException

Constant Value: 2 (0x00000002)

RESULT_INVALID_ARGUMENT

public static final int RESULT_INVALID_ARGUMENT

The caller supplied invalid arguments to the call.

This error may be considered similar to IllegalArgumentException.

Constant Value: 3 (0x00000003)

RESULT_INVALID_SCHEMA

public static final int RESULT_INVALID_SCHEMA

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

Constant Value: 7 (0x00000007)

RESULT_IO_ERROR

public static final int RESULT_IO_ERROR

An issue occurred reading or writing to storage. The call might succeed if repeated.

This error may be considered similar to IOException.

Constant Value: 4 (0x00000004)

RESULT_NOT_FOUND

public static final int RESULT_NOT_FOUND

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

Constant Value: 6 (0x00000006)

RESULT_OK

public static final int RESULT_OK

The call was successful.

Constant Value: 0 (0x00000000)

RESULT_OUT_OF_SPACE

public static final int RESULT_OUT_OF_SPACE

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

Constant Value: 5 (0x00000005)

RESULT_RATE_LIMITED

public static final int RESULT_RATE_LIMITED

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.

Constant Value: 10 (0x0000000a)

RESULT_SECURITY_ERROR

public static final int RESULT_SECURITY_ERROR

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

Constant Value: 8 (0x00000008)

RESULT_TIMED_OUT

public static final int RESULT_TIMED_OUT

The operation was timed out.

Constant Value: 11 (0x0000000b)

RESULT_UNKNOWN_ERROR

public static final int RESULT_UNKNOWN_ERROR

An unknown error occurred while processing the call.

Constant Value: 1 (0x00000001)

equals

public boolean equals (Object other)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getErrorMessage

public 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().

getResultCode

public int getResultCode ()

Returns one of the RESULT constants defined in AppSearchResult.

getResultValue

public 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.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isSuccess

public boolean isSuccess ()

Returns true if getResultCode() equals AppSearchResult.RESULT_OK.

newFailedResult

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

Creates a new failed AppSearchResult.

newSuccessfulResult

public static AppSearchResult<ValueType> newSuccessfulResult (ValueType value)

Creates a new successful AppSearchResult.

toString

public String toString ()

Returns a string representation of the object.