GenAiException

Kotlin |Java

public class GenAiException extends Exception

java.lang.Object
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	com.google.mlkit.genai.common.GenAiException

Represents an exception that occurs during service execution.

Summary

Nested types
@IntDef(value = [ErrorCode.BUSY, ErrorCode.CANCELLED, ErrorCode.NEEDS_SYSTEM_UPDATE, ErrorCode.NOT_AVAILABLE, ErrorCode.NOT_ENOUGH_DISK_SPACE, ErrorCode.NOT_SUPPORTED, ErrorCode.REQUEST_PROCESSING_ERROR, ErrorCode.REQUEST_TOO_LARGE, ErrorCode.RESPONSE_GENERATION_ERROR, ErrorCode.RESPONSE_PROCESSING_ERROR, ErrorCode.REQUEST_TOO_SMALL, ErrorCode.AICORE_INCOMPATIBLE, ErrorCode.INVALID_INPUT_IMAGE, ErrorCode.PER_APP_BATTERY_USE_QUOTA_EXCEEDED, ErrorCode.BACKGROUND_USE_BLOCKED, ErrorCode.CACHE_PROCESSING_ERROR, ErrorCode.STRUCTURED_OUTPUT_REQUEST_ERROR, ErrorCode.STRUCTURED_OUTPUT_RESPONSE_ERROR, ErrorCode.STRUCTURED_OUTPUT_MAX_TOKENS_ERROR, ErrorCode.AUDIO_BUFFER_OVERFLOW]) public annotation GenAiException.ErrorCode The set of error codes.

Nested types

@IntDef(value = [ErrorCode.BUSY, ErrorCode.CANCELLED, ErrorCode.NEEDS_SYSTEM_UPDATE, ErrorCode.NOT_AVAILABLE, ErrorCode.NOT_ENOUGH_DISK_SPACE, ErrorCode.NOT_SUPPORTED, ErrorCode.REQUEST_PROCESSING_ERROR, ErrorCode.REQUEST_TOO_LARGE, ErrorCode.RESPONSE_GENERATION_ERROR, ErrorCode.RESPONSE_PROCESSING_ERROR, ErrorCode.REQUEST_TOO_SMALL, ErrorCode.AICORE_INCOMPATIBLE, ErrorCode.INVALID_INPUT_IMAGE, ErrorCode.PER_APP_BATTERY_USE_QUOTA_EXCEEDED, ErrorCode.BACKGROUND_USE_BLOCKED, ErrorCode.CACHE_PROCESSING_ERROR, ErrorCode.STRUCTURED_OUTPUT_REQUEST_ERROR, ErrorCode.STRUCTURED_OUTPUT_RESPONSE_ERROR, ErrorCode.STRUCTURED_OUTPUT_MAX_TOKENS_ERROR, ErrorCode.AUDIO_BUFFER_OVERFLOW])
public annotation GenAiException.ErrorCode

The set of error codes.

Public fields
`final int`	`@GenAiException.ErrorCode errorCode`
`final @NonNull Duration`	`retryDelay`

Public methods
`int`	`@GenAiException.ErrorCode getErrorCode()` Gets the `ErrorCode`.
`@NonNull Duration`	`getRetryDelay()` Returns the `Duration` to wait before trying again, or `Duration.ZERO` if not known/not applicable.

Inherited methods

From java.lang.Throwable

`synchronized final void`	`addSuppressed(Throwable p)`
`synchronized Throwable`	`fillInStackTrace()`
`synchronized Throwable`	`getCause()`
`String`	`getLocalizedMessage()`
`String`	`getMessage()`
`StackTraceElement[]`	`getStackTrace()`
`synchronized final Throwable[]`	`getSuppressed()`
`synchronized Throwable`	`initCause(Throwable p)`
`void`	`printStackTrace()`
`void`	`setStackTrace(StackTraceElement[] p)`
`String`	`toString()`

Public fields

errorCode

@GenAiException.ErrorCode
public final int errorCode

retryDelay

public final @NonNull Duration retryDelay

Public methods

getErrorCode

@GenAiException.ErrorCode
public int getErrorCode()

Gets the ErrorCode.

getRetryDelay

public @NonNull Duration getRetryDelay()

Returns the Duration to wait before trying again, or Duration.ZERO if not known/not applicable.

For requests to the ML Kit GenAI API that exceed quota, this is the amount of time to wait before trying the request again. For other requests, this value is Duration.ZERO.