# TrainingExamplesInput
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Ctors](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#pubctors)\|[Methods](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#inhmethods)
# TrainingExamplesInput
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/adservices/ondevicepersonalization/TrainingExamplesInput "View this page in Kotlin")\|Java
`
public
final
class
TrainingExamplesInput
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
`
|---|------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.adservices.ondevicepersonalization.TrainingExamplesInput |
*** ** * ** ***
The input data for[IsolatedWorker.onTrainingExamples](https://developer.android.com/reference/android/adservices/ondevicepersonalization/IsolatedWorker#onTrainingExamples(android.adservices.ondevicepersonalization.TrainingExamplesInput,%20android.os.OutcomeReceiver)).
## Summary
| ### Public constructors ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[TrainingExamplesInput](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#TrainingExamplesInput(java.lang.String,%20java.lang.String,%20byte[],%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` populationName, `[String](https://developer.android.com/reference/java/lang/String)` taskName, byte[] resumptionToken, `[String](https://developer.android.com/reference/java/lang/String)` collectionName) ` Creates a new TrainingExamplesInput. |
| ### Public methods ||
|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean` | ` `[equals](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getCollectionName](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#getCollectionName())`() ` The data collection name to use to create training examples. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPopulationName](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#getPopulationName())`() ` The name of the federated compute population. |
| ` byte[]` | ` `[getResumptionToken](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#getResumptionToken())`() ` Token used to support the resumption of training. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getTaskName](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#getTaskName())`() ` The name of the task within the population. |
| ` int` | ` `[hashCode](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExamplesInput#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*. | ||
## Public constructors
### TrainingExamplesInput
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public TrainingExamplesInput (String populationName,
String taskName,
byte[] resumptionToken,
String collectionName)
```
Creates a new TrainingExamplesInput.
| Parameters ||
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `populationName` | `String`: The name of the federated compute population. It should match the population name in[FederatedComputeInput.getPopulationName](https://developer.android.com/reference/android/adservices/ondevicepersonalization/FederatedComputeInput#getPopulationName()). This value cannot be`null`.
|
| `taskName` | `String`: The name of the task within the population. It should match task plan configured at remote federated compute server. One population may have multiple tasks. The task name can be used to uniquely identify the job. This value cannot be`null`.
|
| `resumptionToken` | `byte`: Token used to support the resumption of training. If client app wants to use resumption token to track what examples are already used in previous federated compute jobs, it need set[TrainingExampleRecord.Builder.setResumptionToken](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExampleRecord.Builder#setResumptionToken(byte[])), OnDevicePersonalization will store it and pass it here for generating new training examples. This value may be`null`.
|
| `collectionName` | `String`: The data collection name to use to create training examples. This value may be`null`.
|
## Public methods
### equals
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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`.
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 ||
|-----|-------------------------------------------|
| `o` | `Object`: This value may be`null`.
|
| Returns ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
|
### getCollectionName
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getCollectionName ()
```
The data collection name to use to create training examples.
| Returns ||
|--------------------------------------------------------------------|---------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value may be`null`.
|
### getPopulationName
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getPopulationName ()
```
The name of the federated compute population. It should match the population name in[FederatedComputeInput.getPopulationName()](https://developer.android.com/reference/android/adservices/ondevicepersonalization/FederatedComputeInput#getPopulationName()).
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### getResumptionToken
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public byte[] getResumptionToken ()
```
Token used to support the resumption of training. If client app wants to use resumption token to track what examples are already used in previous federated compute jobs, it need set[TrainingExampleRecord.Builder.setResumptionToken](https://developer.android.com/reference/android/adservices/ondevicepersonalization/TrainingExampleRecord.Builder#setResumptionToken(byte[])), OnDevicePersonalization will store it and pass it here for generating new training examples.
| Returns ||
|----------|---------------------------------|
| `byte[]` | This value may be`null`.
|
### getTaskName
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getTaskName ()
```
The name of the task within the population. It should match task plan configured at remote federated compute server. One population may have multiple tasks. The task name can be used to uniquely identify the job.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### hashCode
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](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 the same integer result.
- It is*not* required that if two objects are unequal according to the[equals](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.
| Returns ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object.
|