TrainingInterval

Kotlin |Java

class TrainingInterval

kotlin.Any
↳	android.adservices.ondevicepersonalization.TrainingInterval

Training interval settings required for federated computation jobs.

Summary

Nested classes
	`Builder` A builder for `TrainingInterval`

Constants
static Int	`SCHEDULING_MODE_ONE_TIME` The scheduling mode for a one-off task.
static Int	`SCHEDULING_MODE_RECURRENT` The scheduling mode for a task that will be rescheduled after each run.

Public methods
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Duration	`getMinimumInterval()` Sets the minimum time interval between two training runs.
Int	`getSchedulingMode()` The scheduling mode for this task, either `SCHEDULING_MODE_ONE_TIME` or `SCHEDULING_MODE_RECURRENT`.
Int	`hashCode()`

Constants

SCHEDULING_MODE_ONE_TIME

Added in API level 35

static val SCHEDULING_MODE_ONE_TIME: Int

The scheduling mode for a one-off task.

Value: 1

SCHEDULING_MODE_RECURRENT

Added in API level 35

static val SCHEDULING_MODE_RECURRENT: Int

The scheduling mode for a task that will be rescheduled after each run.

Value: 2

Public methods

equals

Added in API level 35

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	the reference object with which to compare.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getMinimumInterval

Added in API level 35

fun getMinimumInterval(): Duration

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.

Return
`Duration`	This value cannot be `null`.

getSchedulingMode

Added in API level 35

fun getSchedulingMode(): Int

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.

Return
`Int`	Value is `android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_ONE_TIME`, or `android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_RECURRENT`

hashCode

Added in API level 35

fun hashCode(): Int

Return
`Int`	a hash code value for this object.