Stay organized with collections
Save and categorize content based on your preferences.
FederatedComputeScheduleRequest
class FederatedComputeScheduleRequest
The input for FederatedComputeScheduler.schedule(FederatedComputeScheduleRequest,
.
Summary
Public methods |
Boolean |
Indicates whether some other object is "equal to" this one.
|
FederatedComputeScheduler.Params |
Parameters related to job scheduling.
|
String |
Population refers to a collection of devices that specific task groups can run on.
|
Int |
|
Public constructors
Public methods
equals
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. |
getPopulationName
fun getPopulationName(): String
Population refers to a collection of devices that specific task groups can run on. It should match task plan configured at remote federated compute server.
Return |
String |
This value cannot be null . |
hashCode
fun hashCode(): Int
Return |
Int |
a hash code value for this object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[],[],null,["# FederatedComputeScheduleRequest\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nFederatedComputeScheduleRequest\n===============================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/adservices/ondevicepersonalization/FederatedComputeScheduleRequest \"View this page in Java\") \n\n```\nclass FederatedComputeScheduleRequest\n```\n\n|---|---------------------------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.adservices.ondevicepersonalization.FederatedComputeScheduleRequest](#) |\n\nThe input for [FederatedComputeScheduler.schedule(FederatedComputeScheduleRequest,](/reference/kotlin/android/adservices/ondevicepersonalization/FederatedComputeScheduler#schedule(android.adservices.ondevicepersonalization.FederatedComputeScheduleRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver)).\n\nSummary\n-------\n\n| Public constructors ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [FederatedComputeScheduleRequest](#FederatedComputeScheduleRequest(android.adservices.ondevicepersonalization.FederatedComputeScheduler.Params,%20kotlin.String))`(`params:` `[FederatedComputeScheduler.Params](/reference/kotlin/android/adservices/ondevicepersonalization/FederatedComputeScheduler.Params)`, `populationName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \u003cbr /\u003e |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [FederatedComputeScheduler.Params](/reference/kotlin/android/adservices/ondevicepersonalization/FederatedComputeScheduler.Params) | [getParams](#getParams())`()` Parameters related to job scheduling. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [getPopulationName](#getPopulationName())`()` Population refers to a collection of devices that specific task groups can run on. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` \u003cbr /\u003e |\n\nPublic constructors\n-------------------\n\n### FederatedComputeScheduleRequest\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nFederatedComputeScheduleRequest(\n params: FederatedComputeScheduler.Params, \n populationName: String)\n```\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `params` | [FederatedComputeScheduler.Params](/reference/kotlin/android/adservices/ondevicepersonalization/FederatedComputeScheduler.Params): This value cannot be `null`. |\n| `populationName` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): This value cannot be `null`. |\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\nThe `equals` method implements an equivalence relation on non-null object references:\n\n- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.\n- 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`.\n- 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`.\n- 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.\n- For any non-null reference value `x`, `x.equals(null)` should return `false`.\n\nAn 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.\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `o` | This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### getParams\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getParams(): FederatedComputeScheduler.Params\n```\n\nParameters related to job scheduling.\n\n| Return ||\n|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------|\n| [FederatedComputeScheduler.Params](/reference/kotlin/android/adservices/ondevicepersonalization/FederatedComputeScheduler.Params) | This value cannot be `null`. |\n\n### getPopulationName\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getPopulationName(): String\n```\n\nPopulation refers to a collection of devices that specific task groups can run on. It should match task plan configured at remote federated compute server.\n\n| Return ||\n|----------------------------------------------------------------------------------|------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | This value cannot be `null`. |\n\n### hashCode\n\nAdded in [API level Baklava](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |"]]