FederatedComputeScheduler.Schedule Method

Definition

Namespace:: Android.AdServices.OnDevicePersonalization

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
Schedule(FederatedComputeScheduler+Params, FederatedComputeInput)	Schedules a federated compute job.
Schedule(FederatedComputeScheduleRequest, IExecutor, IOutcomeReceiver)	Schedules a federated compute job.

Schedule(FederatedComputeScheduler+Params, FederatedComputeInput)

Schedules a federated compute job.

[Android.Runtime.Register("schedule", "(Landroid/adservices/ondevicepersonalization/FederatedComputeScheduler$Params;Landroid/adservices/ondevicepersonalization/FederatedComputeInput;)V", "GetSchedule_Landroid_adservices_ondevicepersonalization_FederatedComputeScheduler_Params_Landroid_adservices_ondevicepersonalization_FederatedComputeInput_Handler", ApiSince=35)]
public virtual void Schedule(Android.AdServices.OnDevicePersonalization.FederatedComputeScheduler.Params params, Android.AdServices.OnDevicePersonalization.FederatedComputeInput input);

[<Android.Runtime.Register("schedule", "(Landroid/adservices/ondevicepersonalization/FederatedComputeScheduler$Params;Landroid/adservices/ondevicepersonalization/FederatedComputeInput;)V", "GetSchedule_Landroid_adservices_ondevicepersonalization_FederatedComputeScheduler_Params_Landroid_adservices_ondevicepersonalization_FederatedComputeInput_Handler", ApiSince=35)>]
abstract member Schedule : Android.AdServices.OnDevicePersonalization.FederatedComputeScheduler.Params * Android.AdServices.OnDevicePersonalization.FederatedComputeInput -> unit
override this.Schedule : Android.AdServices.OnDevicePersonalization.FederatedComputeScheduler.Params * Android.AdServices.OnDevicePersonalization.FederatedComputeInput -> unit

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 as described in Federated Compute Server documentation. This value cannot be null.

Attributes: RegisterAttribute

Remarks

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.

Android reference for android.adservices.ondevicepersonalization.FederatedComputeScheduler.schedule.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

Schedule(FederatedComputeScheduleRequest, IExecutor, IOutcomeReceiver)

Schedules a federated compute job.

[Android.Runtime.Register("schedule", "(Landroid/adservices/ondevicepersonalization/FederatedComputeScheduleRequest;Ljava/util/concurrent/Executor;Landroid/os/OutcomeReceiver;)V", "GetSchedule_Landroid_adservices_ondevicepersonalization_FederatedComputeScheduleRequest_Ljava_util_concurrent_Executor_Landroid_os_OutcomeReceiver_Handler", ApiSince=36)]
public virtual void Schedule(Android.AdServices.OnDevicePersonalization.FederatedComputeScheduleRequest federatedComputeScheduleRequest, Java.Util.Concurrent.IExecutor executor, Android.OS.IOutcomeReceiver outcomeReceiver);

[<Android.Runtime.Register("schedule", "(Landroid/adservices/ondevicepersonalization/FederatedComputeScheduleRequest;Ljava/util/concurrent/Executor;Landroid/os/OutcomeReceiver;)V", "GetSchedule_Landroid_adservices_ondevicepersonalization_FederatedComputeScheduleRequest_Ljava_util_concurrent_Executor_Landroid_os_OutcomeReceiver_Handler", ApiSince=36)>]
abstract member Schedule : Android.AdServices.OnDevicePersonalization.FederatedComputeScheduleRequest * Java.Util.Concurrent.IExecutor * Android.OS.IOutcomeReceiver -> unit
override this.Schedule : Android.AdServices.OnDevicePersonalization.FederatedComputeScheduleRequest * Java.Util.Concurrent.IExecutor * Android.OS.IOutcomeReceiver -> unit

Parameters

federatedComputeScheduleRequest: FederatedComputeScheduleRequest

input parameters related to job scheduling.

executor: IExecutor

the Executor on which to invoke the callback.

outcomeReceiver: IOutcomeReceiver

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.

Attributes: RegisterAttribute

Remarks

Schedules a federated compute job. In IsolatedService#onRequest, the app can call IsolatedService#getFederatedComputeScheduler to pass the scheduler when constructing the IsolatedWorker.

Java documentation for android.adservices.ondevicepersonalization.FederatedComputeScheduler.schedule(android.adservices.ondevicepersonalization.FederatedComputeScheduleRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver<android.adservices.ondevicepersonalization.FederatedComputeScheduleResponse, java.lang.Exception>).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to