Added in API level 35

TrainingExamplesInput

class TrainingExamplesInput
kotlin.Any
   ↳ android.adservices.ondevicepersonalization.TrainingExamplesInput

The input data for IsolatedWorker.onTrainingExamples.

Summary

Public constructors
TrainingExamplesInput(populationName: String, taskName: String, resumptionToken: ByteArray?, collectionName: String?)

Creates a new TrainingExamplesInput.
Public methods
Boolean
equals(other: Any?)

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

The data collection name to use to create training examples.
String

The name of the federated compute population.
ByteArray?

Token used to support the resumption of training.
String

The name of the task within the population.
Int

Public constructors

TrainingExamplesInput

Added in API level Baklava
TrainingExamplesInput(
    populationName: String, 
    taskName: String, 
    resumptionToken: ByteArray?, 
    collectionName: String?)

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 ByteArray?: 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
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.

getCollectionName

Added in API level Baklava
fun getCollectionName(): String?

The data collection name to use to create training examples.

Return
String? This value may be null.

getPopulationName

Added in API level 35
fun getPopulationName(): String

The name of the federated compute population. It should match the population name in android.adservices.ondevicepersonalization.FederatedComputeInput#getPopulationName.

Return
String This value cannot be null.

getResumptionToken

Added in API level 35
fun getResumptionToken(): ByteArray?

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.

Return
ByteArray? This value may be null.

getTaskName

Added in API level 35
fun getTaskName(): 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.

Return
String This value cannot be null.

hashCode

Added in API level 35
fun hashCode(): Int
Return
Int a hash code value for this object.