Added in API level 35

Builder


class Builder
kotlin.Any
   ↳ android.adservices.ondevicepersonalization.TrainingInterval.Builder

A builder for TrainingInterval

Summary

Public constructors

Public methods
TrainingInterval

Builds the instance.

TrainingInterval.Builder

Sets the minimum time interval between two training runs.

TrainingInterval.Builder

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

Public constructors

Builder

Added in API level 35
Builder()

Public methods

build

Added in API level 35
fun build(): TrainingInterval

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

Return
TrainingInterval This value cannot be null.

setMinimumInterval

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

Sets the minimum time interval between two training runs.

This field will only be used when the scheduling mode is 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.
Return
TrainingInterval.Builder This value cannot be null.

setSchedulingMode

Added in API level 35
fun setSchedulingMode(value: Int): TrainingInterval.Builder

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

Parameters
value Int: Value is android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_ONE_TIME, or android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_RECURRENT
Return
TrainingInterval.Builder This value cannot be null.