WorkMetricsQuery.Builder

Artifact: androidx.work:work-analytics

View Source

Added in 2.12.0-beta01

---

Kotlin |Java

public final class WorkMetricsQuery.Builder

---

A builder for WorkMetricsQuery.

Summary

Public constructors
Builder()

Public methods
final @NonNull WorkMetricsQuery.Builder	addStates(@NonNull List<@NonNull WorkMetricsInfo.State> states) Adds a List of WorkMetricsInfo.States to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addStates(@NonNull WorkMetricsInfo.State... states) Adds WorkMetricsInfo.States to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addTags(@NonNull List<@NonNull String> tags) Adds a List of tags to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addTags(@NonNull String... tags) Adds tags to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addWorkIds(@NonNull List<@NonNull UUID> workIds) Adds a List of androidx.work.WorkRequest workIds to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addWorkIds(@NonNull UUID... workIds) Adds androidx.work.WorkRequest workIds to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addWorkerClassNames(@NonNull List<@NonNull String> workerClassNames) Adds a List of worker class names to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	addWorkerClassNames(@NonNull String... workerClassNames) Adds worker class names to the WorkMetricsQuery.
final @NonNull WorkMetricsQuery	build() Creates an instance of WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	setBeginTimeMillis(long beginTimeMillis) Sets the start of the enqueue time range to filter the WorkMetricsQuery.
final @NonNull WorkMetricsQuery.Builder	setEndTimeMillis(long endTimeMillis) Sets the end of the enqueue time range to filter the WorkMetricsQuery.

Public constructors

Builder

Added in 2.12.0-beta01

public Builder()

Public methods

addStates

public final @NonNull WorkMetricsQuery.Builder addStates(@NonNull List<@NonNull WorkMetricsInfo.State> states)

Adds a List of WorkMetricsInfo.States to the WorkMetricsQuery.

Parameters
@NonNull List<@NonNull WorkMetricsInfo.State> states	The List of WorkMetricsInfo.States to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addStates

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addStates(@NonNull WorkMetricsInfo.State... states)

Adds WorkMetricsInfo.States to the WorkMetricsQuery.

Parameters
@NonNull WorkMetricsInfo.State... states	The WorkMetricsInfo.States to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addTags

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addTags(@NonNull List<@NonNull String> tags)

Adds a List of tags to the WorkMetricsQuery.

Parameters
@NonNull List<@NonNull String> tags	The List of tags to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addTags

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addTags(@NonNull String... tags)

Adds tags to the WorkMetricsQuery.

Parameters
@NonNull String... tags	The tags to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addWorkIds

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addWorkIds(@NonNull List<@NonNull UUID> workIds)

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

Parameters
@NonNull List<@NonNull UUID> workIds	The List workIds to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addWorkIds

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addWorkIds(@NonNull UUID... workIds)

Adds androidx.work.WorkRequest workIds to the WorkMetricsQuery.

Parameters
@NonNull UUID... workIds	The androidx.work.WorkRequest workIds to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addWorkerClassNames

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addWorkerClassNames(@NonNull List<@NonNull String> workerClassNames)

Adds a List of worker class names to the WorkMetricsQuery.

Parameters
@NonNull List<@NonNull String> workerClassNames	The List of worker class names to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

addWorkerClassNames

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder addWorkerClassNames(@NonNull String... workerClassNames)

Adds worker class names to the WorkMetricsQuery.

Parameters
@NonNull String... workerClassNames	The worker class names to add

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

build

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery build()

Creates an instance of WorkMetricsQuery.

Returns
@NonNull WorkMetricsQuery	the WorkMetricsQuery instance

setBeginTimeMillis

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder setBeginTimeMillis(long beginTimeMillis)

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

Parameters
long beginTimeMillis	The start of the time range (inclusive), in milliseconds since epoch (e.g. System.currentTimeMillis).

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder

setEndTimeMillis

Added in 2.12.0-beta01

public final @NonNull WorkMetricsQuery.Builder setEndTimeMillis(long endTimeMillis)

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

Parameters
long endTimeMillis	The end of the time range (inclusive), in milliseconds since epoch (e.g. System.currentTimeMillis).

Returns
@NonNull WorkMetricsQuery.Builder	the instance of the Builder