WorkMetricsQuery.Builder

Kotlin |Java

class WorkMetricsQuery.Builder

A builder for WorkMetricsQuery.

Summary

Public constructors
`Builder()`

Public functions
`WorkMetricsQuery.Builder`	`addStates(states: List<WorkMetricsInfo.State>)` Adds a `List` of `WorkMetricsInfo.State`s to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addStates(vararg states: WorkMetricsInfo.State)` Adds `WorkMetricsInfo.State`s to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addTags(tags: List<String>)` Adds a `List` of tags to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addTags(vararg tags: String)` Adds tags to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addWorkIds(workIds: List<UUID>)` Adds a `List` of `androidx.work.WorkRequest` `workIds` to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addWorkIds(vararg workIds: UUID)` Adds `androidx.work.WorkRequest` `workIds` to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addWorkerClassNames(workerClassNames: List<String>)` Adds a `List` of worker class names to the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`addWorkerClassNames(vararg workerClassNames: String)` Adds worker class names to the `WorkMetricsQuery`.
`WorkMetricsQuery`	`build()` Creates an instance of `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`setBeginTimeMillis(beginTimeMillis: Long)` Sets the start of the enqueue time range to filter the `WorkMetricsQuery`.
`WorkMetricsQuery.Builder`	`setEndTimeMillis(endTimeMillis: Long)` Sets the end of the enqueue time range to filter the `WorkMetricsQuery`.

Public constructors

Builder

Added in 2.12.0-alpha01

Builder()

Public functions

addStates

fun addStates(states: List<WorkMetricsInfo.State>): WorkMetricsQuery.Builder

Adds a List of WorkMetricsInfo.States to the WorkMetricsQuery.

Parameters
`states: List<WorkMetricsInfo.State>`	The `List` of `WorkMetricsInfo.State`s to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addStates

Added in 2.12.0-alpha01

fun addStates(vararg states: WorkMetricsInfo.State): WorkMetricsQuery.Builder

Adds WorkMetricsInfo.States to the WorkMetricsQuery.

Parameters
`vararg states: WorkMetricsInfo.State`	The `WorkMetricsInfo.State`s to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addTags

Added in 2.12.0-alpha01

fun addTags(tags: List<String>): WorkMetricsQuery.Builder

Adds a List of tags to the WorkMetricsQuery.

Parameters
`tags: List<String>`	The `List` of tags to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addTags

Added in 2.12.0-alpha01

fun addTags(vararg tags: String): WorkMetricsQuery.Builder

Adds tags to the WorkMetricsQuery.

Parameters
`vararg tags: String`	The tags to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addWorkIds

Added in 2.12.0-alpha01

fun addWorkIds(workIds: List<UUID>): WorkMetricsQuery.Builder

Adds a List of androidx.work.WorkRequest workIds to the WorkMetricsQuery.

Parameters
`workIds: List<UUID>`	The `List` `workIds` to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addWorkIds

Added in 2.12.0-alpha01

fun addWorkIds(vararg workIds: UUID): WorkMetricsQuery.Builder

Adds androidx.work.WorkRequest workIds to the WorkMetricsQuery.

Parameters
`vararg workIds: UUID`	The `androidx.work.WorkRequest` `workIds` to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addWorkerClassNames

Added in 2.12.0-alpha01

fun addWorkerClassNames(workerClassNames: List<String>): WorkMetricsQuery.Builder

Adds a List of worker class names to the WorkMetricsQuery.

Parameters
`workerClassNames: List<String>`	The `List` of worker class names to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

addWorkerClassNames

Added in 2.12.0-alpha01

fun addWorkerClassNames(vararg workerClassNames: String): WorkMetricsQuery.Builder

Adds worker class names to the WorkMetricsQuery.

Parameters
`vararg workerClassNames: String`	The worker class names to add

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

build

Added in 2.12.0-alpha01

fun build(): WorkMetricsQuery

Creates an instance of WorkMetricsQuery.

Returns
`WorkMetricsQuery`	the `WorkMetricsQuery` instance

setBeginTimeMillis

Added in 2.12.0-alpha01

fun setBeginTimeMillis(beginTimeMillis: Long): WorkMetricsQuery.Builder

Sets the start of the enqueue time range to filter the WorkMetricsQuery.

Parameters
`beginTimeMillis: Long`	The start of the time range (inclusive)

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`

setEndTimeMillis

Added in 2.12.0-alpha01

fun setEndTimeMillis(endTimeMillis: Long): WorkMetricsQuery.Builder

Sets the end of the enqueue time range to filter the WorkMetricsQuery.

Parameters
`endTimeMillis: Long`	The end of the time range (inclusive)

Returns
`WorkMetricsQuery.Builder`	the instance of the `Builder`