FederatedComputeScheduler

Kotlin |Java

open class FederatedComputeScheduler

kotlin.Any
↳	android.adservices.ondevicepersonalization.FederatedComputeScheduler

Summary

Nested classes
open	`Params` The parameters related to job scheduling.

Public methods
open Unit	`cancel(input: FederatedComputeInput)` Cancels a federated compute job with input training params.
open Unit	`schedule(params: FederatedComputeScheduler.Params, input: FederatedComputeInput)` Schedules a federated compute job.

open fun cancel(input: FederatedComputeInput): Unit

Cancels a federated compute job with input training params. In android.adservices.ondevicepersonalization.IsolatedService#onRequest, the app can call android.adservices.ondevicepersonalization.IsolatedService#getFederatedComputeScheduler 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`.

open fun schedule(
    params: FederatedComputeScheduler.Params, 
    input: FederatedComputeInput
): Unit

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