TrainingInterval

public final class TrainingInterval
extends Object

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


Training interval settings required for federated computation jobs.

Summary

Nested classes

class TrainingInterval.Builder

A builder for TrainingInterval 

Constants

int SCHEDULING_MODE_ONE_TIME

The scheduling mode for a one-off task.

int SCHEDULING_MODE_RECURRENT

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

Public methods

boolean equals(Object o)

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

Duration getMinimumInterval()

Sets the minimum time interval between two training runs.

int getSchedulingMode()
int hashCode()

Returns a hash code value for the object.

Inherited methods

Constants

SCHEDULING_MODE_ONE_TIME

public static final int SCHEDULING_MODE_ONE_TIME

The scheduling mode for a one-off task.

Constant Value: 1 (0x00000001)

SCHEDULING_MODE_RECURRENT

public static final int SCHEDULING_MODE_RECURRENT

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

Constant Value: 2 (0x00000002)

Public methods

equals

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.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getMinimumInterval

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

Returns
Duration This value cannot be null.

getSchedulingMode

public int getSchedulingMode ()

Returns
int Value is SCHEDULING_MODE_ONE_TIME, or SCHEDULING_MODE_RECURRENT

hashCode

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

Returns
int a hash code value for this object.