# WorkMetricsQuery.Builder

Artifact: [androidx.work:work-analytics](https://developer.android.com/jetpack/androidx/releases/work) [View Source](https://cs.android.com/search?q=file:androidx/work/analytics/WorkMetricsQuery.kt+class:androidx.work.analytics.WorkMetricsQuery.Builder) Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

*** ** * ** ***


```
class WorkMetricsQuery.Builder
```

<br />

*** ** * ** ***

A builder for `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#Builder()()` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addStates(kotlin.collections.List)(states: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State>)` Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addStates(kotlin.Array)(vararg states: https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State)` Adds `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addTags(kotlin.collections.List)(tags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>)` Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of tags to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addTags(kotlin.Array)(vararg tags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Adds tags to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addWorkIds(kotlin.collections.List)(workIds: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/java/util/UUID.html>)` Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addWorkIds(kotlin.Array)(vararg workIds: https://developer.android.com/reference/java/util/UUID.html)` Adds `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addWorkerClassNames(kotlin.collections.List)(workerClassNames: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>)` Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of worker class names to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#addWorkerClassNames(kotlin.Array)(vararg workerClassNames: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Adds worker class names to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#build()()` Creates an instance of `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#setBeginTimeMillis(kotlin.Long)(beginTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Sets the start of the enqueue time range to filter the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder#setEndTimeMillis(kotlin.Long)(endTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Sets the end of the enqueue time range to filter the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`. |

## Public constructors

### Builder

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

```
Builder()
```

## Public functions

### addStates

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

Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `states: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State>` | The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addStates

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `vararg states: https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State` | The `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsInfo.State`s to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addTags

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of tags to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `tags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` | The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of tags to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addTags

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds tags to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `vararg tags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The tags to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addWorkIds

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `workIds: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/java/util/UUID.html>` | The `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addWorkIds

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `vararg workIds: https://developer.android.com/reference/java/util/UUID.html` | The `https://developer.android.com/reference/kotlin/androidx/work/WorkRequest` `workIds` to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addWorkerClassNames

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of worker class names to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `workerClassNames: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>` | The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of worker class names to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### addWorkerClassNames

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

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

Adds worker class names to the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `vararg workerClassNames: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The worker class names to add |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### build

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

```
fun build(): WorkMetricsQuery
```

Creates an instance of `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery` | the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery` instance |

### setBeginTimeMillis

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

```
fun setBeginTimeMillis(beginTimeMillis: Long): WorkMetricsQuery.Builder
```

Sets the start of the enqueue time range to filter the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `beginTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The start of the time range (inclusive), in milliseconds since epoch (e.g. `https://developer.android.com/reference/java/lang/System.html#currentTimeMillis()`). |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |

### setEndTimeMillis

Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)

```
fun setEndTimeMillis(endTimeMillis: Long): WorkMetricsQuery.Builder
```

Sets the end of the enqueue time range to filter the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery`.

| Parameters |
|---|---|
| `endTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The end of the time range (inclusive), in milliseconds since epoch (e.g. `https://developer.android.com/reference/java/lang/System.html#currentTimeMillis()`). |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` | the instance of the `https://developer.android.com/reference/kotlin/androidx/work/analytics/WorkMetricsQuery.Builder` |