[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  
Summary: [Nested Classes](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#nestedclasses) \| [Constants](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#constants) \| [Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#pubmethods) \| [Inherited Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#inhmethods)  

# TrainingInterval


`
public

final

class
TrainingInterval
`


`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


`

`


`

|---|-------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.adservices.ondevicepersonalization.TrainingInterval |

<br />

*** ** * ** ***

Training interval settings required for federated computation jobs.

## Summary

|                                                                                                                                                             ### Nested classes                                                                                                                                                              ||
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [TrainingInterval.Builder](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval.Builder) A builder for [TrainingInterval](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval) |

|                                                                                                                            ### Constants                                                                                                                             ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [SCHEDULING_MODE_ONE_TIME](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#SCHEDULING_MODE_ONE_TIME) The scheduling mode for a one-off task.                                    |
| `int` | [SCHEDULING_MODE_RECURRENT](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#SCHEDULING_MODE_RECURRENT) The scheduling modes for a task that will be rescheduled after each run. |

|                                                                                                                                                                                  ### Public methods                                                                                                                                                                                   ||
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean`                                                                | ` `[equals](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. |
| ` `[Duration](https://developer.android.com/reference/java/time/Duration) | ` `[getMinimumInterval](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#getMinimumInterval())`() ` Sets the minimum time interval between two training runs.                                                                 |
| ` int`                                                                    | ` `[getSchedulingMode](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#getSchedulingMode())`() `                                                                                                                             |
| ` int`                                                                    | ` `[hashCode](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#hashCode())`() ` Returns a hash code value for the object.                                                                                                     |

| ### Inherited methods |
|-----------------------|---|
| From class ` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                        | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                             | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                            | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`.                                                                                                                                                 | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                   | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                              | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                           | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                              | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.                                                                                             | ||

## Constants

### SCHEDULING_MODE_ONE_TIME

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public static final int SCHEDULING_MODE_ONE_TIME
```

The scheduling mode for a one-off task.

<br />

Constant Value:

1
(0x00000001)


### SCHEDULING_MODE_RECURRENT

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public static final int SCHEDULING_MODE_RECURRENT
```

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

<br />

Constant Value:

2
(0x00000002)


## Public methods

### equals

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public boolean equals (Object o)
```

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`.


The `equals` method for class `Object` implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values `x` and
`y`, this method returns `true` if and only
if `x` and `y` refer to the same object
(`x == y` has the value `true`).


Note that it is generally necessary to override the `hashCode`
method whenever this method is overridden, so as to maintain the
general contract for the `hashCode` method, which states
that equal objects must have equal hash codes.

<br />

|                   Parameters                    ||
|-----|--------------------------------------------|
| `o` | `Object`: This value may be `null`. <br /> |

|                                           Returns                                           ||
|-----------|----------------------------------------------------------------------------------|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getMinimumInterval

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public Duration getMinimumInterval ()
```

Sets the minimum time interval between two training runs.

This field will only be used when the scheduling mode is [SCHEDULING_MODE_RECURRENT](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/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.

<br />

|                                                   Returns                                                   ||
|------------------------------------------------------------------------|-------------------------------------|
| [Duration](https://developer.android.com/reference/java/time/Duration) | This value cannot be `null`. <br /> |

### getSchedulingMode

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public int getSchedulingMode ()
```

<br />

<br />

|                                                                                                                                                                                              Returns                                                                                                                                                                                               ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is [SCHEDULING_MODE_ONE_TIME](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#SCHEDULING_MODE_ONE_TIME), or [SCHEDULING_MODE_RECURRENT](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/ondevicepersonalization/TrainingInterval#SCHEDULING_MODE_RECURRENT) <br /> |

### hashCode

[**Added in Android UpsideDownCakePrivacySandbox**](https://developer.android.com/preview)  

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
[HashMap](https://developer.android.com/reference/java/util/HashMap).


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `equals(Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the [equals(java.lang.Object)](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)) method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.


As much as is reasonably practical, the hashCode method defined
by class `Object` does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)

<br />

|                     Returns                      ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object. <br /> |