FederatedComputeScheduler

Kotlin |Java

public class FederatedComputeScheduler
extends Object

java.lang.Object
↳	android.adservices.ondevicepersonalization.FederatedComputeScheduler

Handles scheduling federated compute jobs. See IsolatedService.getFederatedComputeScheduler(RequestToken).

Summary

Nested classes
`class`	`FederatedComputeScheduler.Params` The parameters related to job scheduling.

Public methods
`void`	`cancel(FederatedComputeInput input)` Cancels a federated compute job with input training params.
`void`	`schedule(FederatedComputeScheduler.Params params, FederatedComputeInput input)` Schedules a federated compute job.
`void`	`schedule(FederatedComputeScheduleRequest federatedComputeScheduleRequest, OutcomeReceiver<FederatedComputeScheduleResponse, Exception> outcomeReceiver)` Schedules a federated compute job.

Inherited methods

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.

Public methods

cancel

Added in API level 35

public void cancel (FederatedComputeInput input)

Cancels a federated compute job with input training params. In IsolatedService.onRequest(RequestToken), the app can call IsolatedService.getFederatedComputeScheduler(RequestToken) to pass scheduler when constructing the IsolatedWorker.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`input`	`FederatedComputeInput`: the configuration of the federated compute. It should be consistent with the federated compute server setup. This value cannot be `null`.

schedule

Added in API level 35

public void schedule (FederatedComputeScheduler.Params params, 
                FederatedComputeInput input)

Schedules a federated compute job. In IsolatedService.onRequest, the app can call IsolatedService.getFederatedComputeScheduler to pass the scheduler when constructing the IsolatedWorker.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`params`	`FederatedComputeScheduler.Params`: parameters related to job scheduling. This value cannot be `null`.
`input`	`FederatedComputeInput`: the configuration of the federated computation. It should be consistent with the federated compute server setup. This value cannot be `null`.

schedule

Added in Android Baklava

public void schedule (FederatedComputeScheduleRequest federatedComputeScheduleRequest, 
                OutcomeReceiver<FederatedComputeScheduleResponse, Exception> outcomeReceiver)

Parameters

Parameters
`federatedComputeScheduleRequest`	`FederatedComputeScheduleRequest`: input parameters related to job scheduling. This value cannot be `null`.
`outcomeReceiver`	`OutcomeReceiver`: This either returns a `FederatedComputeScheduleResponse` on success, or `Exception` on failure. The exception type is `OnDevicePersonalizationException` with error code `OnDevicePersonalizationException.ERROR_INVALID_TRAINING_MANIFEST` if the manifest is missing the federated compute server URL or `OnDevicePersonalizationException.ERROR_SCHEDULE_TRAINING_FAILED` when scheduling fails for other reasons. This value cannot be `null`.

federatedComputeScheduleRequest

FederatedComputeScheduleRequest: input parameters related to job scheduling. This value cannot be null.

outcomeReceiver

OutcomeReceiver: This either returns a FederatedComputeScheduleResponse on success, or Exception on failure. The exception type is OnDevicePersonalizationException with error code OnDevicePersonalizationException.ERROR_INVALID_TRAINING_MANIFEST if the manifest is missing the federated compute server URL or OnDevicePersonalizationException.ERROR_SCHEDULE_TRAINING_FAILED when scheduling fails for other reasons. This value cannot be null.

FederatedComputeScheduler

Summary

Nested classes

Public methods

Inherited methods

Public methods

cancel

schedule

schedule