Added in API level 35

Summary: Constants | Methods | Inherited Methods

OnDevicePersonalizationException

Kotlin |Java

public class OnDevicePersonalizationException
extends Exception

java.lang.Object
↳	java.lang.Throwable
	↳	java.lang.Exception
		↳	android.adservices.ondevicepersonalization.OnDevicePersonalizationException

Exception thrown by OnDevicePersonalization APIs.

Summary

Constants
`int`	`ERROR_INFERENCE_FAILED` `ModelManager` failed to run inference.
`int`	`ERROR_INFERENCE_MODEL_NOT_FOUND` Inference failed due to `ModelManager` not finding the downloaded model.
`int`	`ERROR_INVALID_TRAINING_MANIFEST` The `IsolatedService`'s call to `FederatedComputeScheduler.schedule` failed due to missing or misconfigured federated compute settings URL in the manifest.
`int`	`ERROR_ISOLATED_SERVICE_FAILED` The `IsolatedService` that was invoked failed to run.
`int`	`ERROR_ISOLATED_SERVICE_LOADING_FAILED` The ODP module was unable to load the `IsolatedService`.
`int`	`ERROR_ISOLATED_SERVICE_MANIFEST_PARSING_FAILED` The ODP specific manifest settings for the `IsolatedService` are either missing or misconfigured.
`int`	`ERROR_ISOLATED_SERVICE_TIMEOUT` The `IsolatedService` was invoked but timed out before returning successfully.
`int`	`ERROR_PERSONALIZATION_DISABLED` The `IsolatedService` was not started because personalization is disabled by device configuration.
`int`	`ERROR_SCHEDULE_TRAINING_FAILED` The `IsolatedService`'s call to `FederatedComputeScheduler.schedule` failed.

Public methods
`int`	`getErrorCode()` Returns the error code for this exception.

Inherited methods

From class


        
          java.lang.Throwable

`final void`	`addSuppressed(Throwable exception)` Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()` Fills in the execution stack trace.
`Throwable`	`getCause()` Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
`String`	`getLocalizedMessage()` Creates a localized description of this throwable.
`String`	`getMessage()` Returns the detail message string of this throwable.
`StackTraceElement[]`	`getStackTrace()` Provides programmatic access to the stack trace information printed by `printStackTrace()`.
`final Throwable[]`	`getSuppressed()` Returns an array containing all of the exceptions that were suppressed, typically by the `try`-with-resources statement, in order to deliver this exception.
`Throwable`	`initCause(Throwable cause)` Initializes the cause of this throwable to the specified value.
`void`	`printStackTrace()` Prints this throwable and its backtrace to the standard error stream.
`void`	`printStackTrace(PrintWriter s)` Prints this throwable and its backtrace to the specified print writer.
`void`	`printStackTrace(PrintStream s)` Prints this throwable and its backtrace to the specified print stream.
`void`	`setStackTrace(StackTraceElement[] stackTrace)` Sets the stack trace elements that will be returned by `getStackTrace()` and printed by `printStackTrace()` and related methods.
`String`	`toString()` Returns a short description of this throwable.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ERROR_INFERENCE_FAILED

Added in Android Baklava

public static final int ERROR_INFERENCE_FAILED

ModelManager failed to run inference.

Retrying may be successful if the issue is due to a platform internal error.

Constant Value: 9 (0x00000009)

ERROR_INFERENCE_MODEL_NOT_FOUND

Added in Android Baklava

public static final int ERROR_INFERENCE_MODEL_NOT_FOUND

Inference failed due to ModelManager not finding the downloaded model.

Constant Value: 8 (0x00000008)

ERROR_INVALID_TRAINING_MANIFEST

Added in Android Baklava

public static final int ERROR_INVALID_TRAINING_MANIFEST

The IsolatedService's call to FederatedComputeScheduler.schedule failed due to missing or misconfigured federated compute settings URL in the manifest.

Constant Value: 7 (0x00000007)

ERROR_ISOLATED_SERVICE_FAILED

Added in API level 35

public static final int ERROR_ISOLATED_SERVICE_FAILED

The IsolatedService that was invoked failed to run.

Constant Value: 1 (0x00000001)

ERROR_ISOLATED_SERVICE_LOADING_FAILED

Added in Android Baklava

public static final int ERROR_ISOLATED_SERVICE_LOADING_FAILED

The ODP module was unable to load the IsolatedService.

Retrying may be successful for platform internal errors.

Constant Value: 3 (0x00000003)

ERROR_ISOLATED_SERVICE_MANIFEST_PARSING_FAILED

Added in Android Baklava

public static final int ERROR_ISOLATED_SERVICE_MANIFEST_PARSING_FAILED

The ODP specific manifest settings for the IsolatedService are either missing or misconfigured.

Constant Value: 4 (0x00000004)

ERROR_ISOLATED_SERVICE_TIMEOUT

Added in Android Baklava

public static final int ERROR_ISOLATED_SERVICE_TIMEOUT

The IsolatedService was invoked but timed out before returning successfully.

This is likely due to an issue with the IsolatedWorker implementation taking too long and retries are likely to fail.

Constant Value: 5 (0x00000005)

ERROR_PERSONALIZATION_DISABLED

Added in API level 35

public static final int ERROR_PERSONALIZATION_DISABLED

The IsolatedService was not started because personalization is disabled by device configuration.

Constant Value: 2 (0x00000002)

ERROR_SCHEDULE_TRAINING_FAILED

Added in Android Baklava

public static final int ERROR_SCHEDULE_TRAINING_FAILED

The IsolatedService's call to FederatedComputeScheduler.schedule failed.

Retrying may be successful if the issue is due to a platform internal error.

Constant Value: 6 (0x00000006)

Public methods

getErrorCode

Added in API level 35

public int getErrorCode ()

Returns the error code for this exception.

Returns
`int`	Value is `ERROR_ISOLATED_SERVICE_FAILED`, `ERROR_PERSONALIZATION_DISABLED`, `ERROR_ISOLATED_SERVICE_LOADING_FAILED`, `ERROR_ISOLATED_SERVICE_MANIFEST_PARSING_FAILED`, `ERROR_ISOLATED_SERVICE_TIMEOUT`, `ERROR_SCHEDULE_TRAINING_FAILED`, `ERROR_INVALID_TRAINING_MANIFEST`, `ERROR_INFERENCE_MODEL_NOT_FOUND`, or `ERROR_INFERENCE_FAILED`