Stay organized with collections
Save and categorize content based on your preferences.
TrainingInterval
class TrainingInterval
Training interval settings required for federated computation jobs.
Summary
| Constants |
| static Int |
The scheduling mode for a one-off task.
|
| static Int |
The scheduling mode for a task that will be rescheduled after each run.
|
Constants
SCHEDULING_MODE_ONE_TIME
static val SCHEDULING_MODE_ONE_TIME: Int
The scheduling mode for a one-off task.
Value: 1
SCHEDULING_MODE_RECURRENT
static val SCHEDULING_MODE_RECURRENT: Int
The scheduling mode for a task that will be rescheduled after each run.
Value: 2
Public methods
equals
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
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. |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# TrainingInterval\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nTrainingInterval\n================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/adservices/ondevicepersonalization/TrainingInterval \"View this page in Java\") \n\n```\nclass TrainingInterval\n```\n\n|---|------------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.adservices.ondevicepersonalization.TrainingInterval](#) |\n\nTraining interval settings required for federated computation jobs.\n\nSummary\n-------\n\n| Nested classes ||\n|---|--------------------------------------------------------------------------------------------------------------------------------------|\n| | [Builder](/reference/kotlin/android/adservices/ondevicepersonalization/TrainingInterval.Builder) A builder for [TrainingInterval](#) |\n\n| Constants ||\n|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SCHEDULING_MODE_ONE_TIME](#SCHEDULING_MODE_ONE_TIME:kotlin.Int) The scheduling mode for a one-off task. |\n| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SCHEDULING_MODE_RECURRENT](#SCHEDULING_MODE_RECURRENT:kotlin.Int) The scheduling mode for a task that will be rescheduled after each run. |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [Duration](../../../java/time/Duration.html#) | [getMinimumInterval](#getMinimumInterval())`()` Sets the minimum time interval between two training runs. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getSchedulingMode](#getSchedulingMode())`()` The scheduling mode for this task, either [SCHEDULING_MODE_ONE_TIME](#SCHEDULING_MODE_ONE_TIME:kotlin.Int) or [SCHEDULING_MODE_RECURRENT](#SCHEDULING_MODE_RECURRENT:kotlin.Int). |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` \u003cbr /\u003e |\n\nConstants\n---------\n\n### SCHEDULING_MODE_ONE_TIME\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val SCHEDULING_MODE_ONE_TIME: Int\n```\n\nThe scheduling mode for a one-off task. \n\n Value: 1\n\n### SCHEDULING_MODE_RECURRENT\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val SCHEDULING_MODE_RECURRENT: Int\n```\n\nThe scheduling mode for a task that will be rescheduled after each run. \n\n Value: 2\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\nThe `equals` method implements an equivalence relation on non-null object references:\n\n- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.\n- 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`.\n- 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`.\n- 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.\n- For any non-null reference value `x`, `x.equals(null)` should return `false`.\n\nAn 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.\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `o` | This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### getMinimumInterval\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getMinimumInterval(): Duration\n```\n\nSets the minimum time interval between two training runs.\n\nThis field will only be used when the scheduling mode is [SCHEDULING_MODE_RECURRENT](#SCHEDULING_MODE_RECURRENT:kotlin.Int). Only positive values are accepted, zero or negative values will result in IllegalArgumentException.\n\nPlease 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.\n\n| Return ||\n|-----------------------------------------------|------------------------------|\n| [Duration](../../../java/time/Duration.html#) | This value cannot be `null`. |\n\n### getSchedulingMode\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getSchedulingMode(): Int\n```\n\nThe scheduling mode for this task, either [SCHEDULING_MODE_ONE_TIME](#SCHEDULING_MODE_ONE_TIME:kotlin.Int) or [SCHEDULING_MODE_RECURRENT](#SCHEDULING_MODE_RECURRENT:kotlin.Int). The default scheduling mode is [SCHEDULING_MODE_ONE_TIME](#SCHEDULING_MODE_ONE_TIME:kotlin.Int) if unspecified.\n\n| Return ||\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Value is [android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_ONE_TIME](#SCHEDULING_MODE_ONE_TIME:kotlin.Int), or [android.adservices.ondevicepersonalization.TrainingInterval#SCHEDULING_MODE_RECURRENT](#SCHEDULING_MODE_RECURRENT:kotlin.Int) |\n\n### hashCode\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |"]]
