[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  
Summary:[Nested Classes](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler#nestedclasses)\|[Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler#pubmethods)\|[Inherited Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler#inhmethods)  

# FederatedComputeScheduler

`
public


class
FederatedComputeScheduler
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|----------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.adservices.ondevicepersonalization.FederatedComputeScheduler |

<br />

*** ** * ** ***

Handles scheduling federated learning and federated analytic jobs.

## Summary

|                                                                                                          ### Nested classes                                                                                                           ||
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [FederatedComputeScheduler.Params](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler.Params) The parameters related to job scheduling. |

|                                                                                                                                                                                                                                                                                                                                                         ### Public methods                                                                                                                                                                                                                                                                                                                                                         ||
|---------| |
| ` void` | ` `[cancel](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler#cancel(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` populationName) ` Cancel a federated computation job with input training params.                                                                                                                                                                                                                                                                                                                                                                                       |
| ` void` | ` `[schedule](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler#schedule(android.adservices.ondevicepersonalization.FederatedComputeScheduler.Params,%20android.adservices.ondevicepersonalization.FederatedComputeInput))`(`[FederatedComputeScheduler.Params](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeScheduler.Params)` params, `[FederatedComputeInput](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/FederatedComputeInput)` input) ` Schedule a federated computation job. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Public methods

### cancel

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

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

<br />

|                                                      Parameters                                                       ||
|------------------|-----------------------------------------------------------------------------------------------------|
| `populationName` | `String`: population name of the job that caller wants to cancel This value cannot be`null`. <br /> |

|                                                                            Throws                                                                             ||
|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException) | caused by an internal failure of FederatedComputeScheduler. |

### schedule

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

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

<br />

|                                                                                                                     Parameters                                                                                                                      ||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `params` | `FederatedComputeScheduler.Params`: parameters related to job scheduling. This value cannot be`null`. <br />                                                                                                                              |
| `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`. <br /> |

|                                                                               Throws                                                                                ||
|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | caused by caller supplied invalid input argument.           |
| [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException)       | caused by an internal failure of FederatedComputeScheduler. |