FederatedComputeScheduler

public class FederatedComputeScheduler
extends Object

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

Handles scheduling federated learning and federated analytic jobs.

Summary

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

Public methods
`void`	`cancel(String populationName)` Cancel a federated computation job with input training params.
`void`	`schedule(FederatedComputeScheduler.Params params, FederatedComputeInput input)` Schedule a federated computation 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 Android UpsideDownCakePrivacySandbox

public void cancel (String populationName)

Cancel a federated computation job with input training params.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`populationName`	`String`: population name of the job that caller wants to cancel This value cannot be `null`.

Throws
`IllegalStateException`	caused by an internal failure of FederatedComputeScheduler.

schedule

Added in Android UpsideDownCakePrivacySandbox

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

Schedule a federated computation job.
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 related o federated computation. It should be consistent with federated computation server setup. TODO(b/300461799): add federated compute server document. This value cannot be `null`.

Throws
`IllegalArgumentException`	caused by caller supplied invalid input argument.
`IllegalStateException`	caused by an internal failure of FederatedComputeScheduler.

FederatedComputeScheduler

Summary

Nested classes

Public methods

Inherited methods

Public methods

cancel

schedule