TrainingInterval.Builder


public static final class TrainingInterval.Builder
extends Object

java.lang.Object
   ↳ android.adservices.ondevicepersonalization.TrainingInterval.Builder


A builder for TrainingInterval

Summary

Public constructors

Builder()

Public methods

TrainingInterval build()

Builds the instance.

TrainingInterval.Builder setMinimumInterval(Duration value)

Sets the minimum time interval between two training runs.

TrainingInterval.Builder setSchedulingMode(int value)

The scheduling mode for this task, either TrainingInterval.SCHEDULING_MODE_ONE_TIME or TrainingInterval.SCHEDULING_MODE_RECURRENT.

Inherited methods

Public constructors

Builder

Added in API level 35
public Builder ()

Public methods

build

Added in API level 35
public TrainingInterval build ()

Builds the instance. This builder should not be touched after calling this!

Returns
TrainingInterval This value cannot be null.

setMinimumInterval

Added in API level 35
public TrainingInterval.Builder setMinimumInterval (Duration value)

Sets the minimum time interval between two training runs.

This field will only be used when the scheduling mode is TrainingInterval.SCHEDULING_MODE_RECURRENT. Only positive values are accepted, zero or negative values will result in IllegalArgumentException.

Please also note this value is advisory, which does not guarantee the job will be run immediately after the interval expired. Federated compute will still enforce a minimum required interval and training constraints to ensure system health. The current training constraints are device on unmetered network, idle and battery not low.

Parameters
value Duration: This value cannot be null.

Returns
TrainingInterval.Builder This value cannot be null.

setSchedulingMode

Added in API level 35
public TrainingInterval.Builder setSchedulingMode (int value)

The scheduling mode for this task, either TrainingInterval.SCHEDULING_MODE_ONE_TIME or TrainingInterval.SCHEDULING_MODE_RECURRENT. The default scheduling mode is TrainingInterval.SCHEDULING_MODE_ONE_TIME if unspecified.

Parameters
value int: Value is TrainingInterval.SCHEDULING_MODE_ONE_TIME, or TrainingInterval.SCHEDULING_MODE_RECURRENT

Returns
TrainingInterval.Builder This value cannot be null.