TrainingExamplesInput

Kotlin |Java

public final class TrainingExamplesInput
extends Object

java.lang.Object
↳	android.adservices.ondevicepersonalization.TrainingExamplesInput

The input data for IsolatedWorker.onTrainingExamples.

Summary

Public constructors
`TrainingExamplesInput(String populationName, String taskName, byte[] resumptionToken, String collectionName)` Creates a new TrainingExamplesInput.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getCollectionName()` The data collection name to use to create training examples.
`String`	`getPopulationName()` The name of the federated compute population.
`byte[]`	`getResumptionToken()` Token used to support the resumption of training.
`String`	`getTaskName()` The name of the task within the population.
`int`	`hashCode()` Returns a hash code value for the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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(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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

TrainingExamplesInput

Added in Android Baklava

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

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 Android Baklava

public String getCollectionName ()

The data collection name to use to create training examples.

Returns
`String`	This value may be `null`.

getPopulationName

Added in API level 35

public String getPopulationName ()

The name of the federated compute population. It should match the population name in FederatedComputeInput.getPopulationName().

Returns
`String`	This value cannot be `null`.

getResumptionToken

Added in API level 35

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, 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

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`	This value cannot be `null`.

hashCode

Added in API level 35

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.

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