WorkMetricsInfoRepository
@ExperimentalEventsApi
@ExperimentalWorkMetricsApi
public final class WorkMetricsInfoRepository implements ScheduleEventListener, ExecutionEventListener
Repository class that calculates and stores metrics info and analytics about workers.
Summary
Public fields |
|
|---|---|
static final long |
The default retention time for finished work metrics (7 days). |
static final long |
The maximum allowed retention time for finished work metrics (30 days). |
Public constructors |
|---|
WorkMetricsInfoRepository(@NonNull Context context, Executor dbExecutor)Creates an instance of |
@RequiresApi(value = 26)Creates an instance of |
WorkMetricsInfoRepository(Creates an instance of |
Public methods |
|
|---|---|
final @NonNull Flow<@NonNull WorkMetricsInfo> |
A hot |
final @NonNull List<@NonNull WorkMetricsInfo> |
getWorkMetricsInfoById(@NonNull UUID workId)Gets a list of |
final @NonNull List<@NonNull WorkMetricsInfo> |
Gets a list of |
void |
onCancelled(@NonNull WorkInfo workInfo)Called when a work request is canceled from the app e.g. |
void |
onEnqueued(@NonNull WorkInfo workInfo)Called when a work request is enqueued from the app e.g. |
void |
onException(@NonNull Throwable throwable, @NonNull WorkInfo workInfo)Called when the work request fails from an exception after it has started. |
void |
onFinished(Called when the worker finishes and returns a value. |
void |
onPrerequisiteFailed(@NonNull WorkInfo workInfo)Called when a work request fails because a prerequisite work fails. |
void |
Called when a work request starts executing i.e. |
void |
Called when a work request is stopped by the system after it has started. |
void |
onUnblocked(@NonNull WorkInfo workInfo)Called when a work request is no longer waiting on any of its prerequisite work. |
void |
Called when a work request is updated from the app e.g. |
Public fields
DEFAULT_RETENTION_TIME_MILLIS
public static final long DEFAULT_RETENTION_TIME_MILLIS
The default retention time for finished work metrics (7 days).
MAX_RETENTION_TIME_MILLIS
public static final long MAX_RETENTION_TIME_MILLIS
The maximum allowed retention time for finished work metrics (30 days).
Public constructors
WorkMetricsInfoRepository
public WorkMetricsInfoRepository(@NonNull Context context, Executor dbExecutor)
Creates an instance of WorkMetricsInfoRepository with a default retention of DEFAULT_RETENTION_TIME_MILLIS.
It is recommended that the Executor passed here is the same as the one passed into androidx.work.Configuration.Builder.setTaskExecutor. If no executor is provided, Room's default executors will be used instead.
Note that this executor is only used for database operations and not for running the event hooks themselves.
WorkMetricsInfoRepository
@RequiresApi(value = 26)
public WorkMetricsInfoRepository(
@NonNull Context context,
@NonNull Duration retentionDuration,
Executor dbExecutor
)
Creates an instance of WorkMetricsInfoRepository with a custom retention duration.
WorkMetricsInfoRepository
public WorkMetricsInfoRepository(
@NonNull Context context,
long retentionTime,
@NonNull TimeUnit retentionTimeUnit,
Executor dbExecutor
)
Creates an instance of WorkMetricsInfoRepository with a custom retention time.
| Parameters | |
|---|---|
@NonNull Context context |
The application |
long retentionTime |
The retention time. Clamped to a maximum of |
@NonNull TimeUnit retentionTimeUnit |
The |
Executor dbExecutor |
The |
Public methods
getFinishedWorkMetricsInfoFlow
public final @NonNull Flow<@NonNull WorkMetricsInfo> getFinishedWorkMetricsInfoFlow()
A hot Flow that emits a WorkMetricsInfo whenever one finishes.
A WorkMetricsInfo is considered finished when the request period is complete or obsolete, either because the work finished or a new request period started (e.g. if the work request is updated or a periodic request completes a period).
getWorkMetricsInfoById
public final @NonNull List<@NonNull WorkMetricsInfo> getWorkMetricsInfoById(@NonNull UUID workId)
Gets a list of WorkMetricsInfo snapshots for a given work id.
| Parameters | |
|---|---|
@NonNull UUID workId |
The identifier of the |
| Returns | |
|---|---|
@NonNull List<@NonNull WorkMetricsInfo> |
A list of |
getWorkMetricsInfos
public final @NonNull List<@NonNull WorkMetricsInfo> getWorkMetricsInfos(@NonNull WorkMetricsQuery query)
Gets a list of WorkMetricsInfo matching the query criteria.
| Parameters | |
|---|---|
@NonNull WorkMetricsQuery query |
The |
| Returns | |
|---|---|
@NonNull List<@NonNull WorkMetricsInfo> |
A list of |
onCancelled
public void onCancelled(@NonNull WorkInfo workInfo)
Called when a work request is canceled from the app e.g. WorkManager.cancelWorkById.
onEnqueued
public void onEnqueued(@NonNull WorkInfo workInfo)
Called when a work request is enqueued from the app e.g. WorkManager.enqueue.
onException
public void onException(@NonNull Throwable throwable, @NonNull WorkInfo workInfo)
Called when the work request fails from an exception after it has started.
onFinished
public void onFinished(
@NonNull ListenableWorker.Result result,
@NonNull WorkInfo workInfo
)
Called when the worker finishes and returns a value.
| Parameters | |
|---|---|
@NonNull ListenableWorker.Result result |
|
@NonNull WorkInfo workInfo |
Snapshot of the work info |
onPrerequisiteFailed
public void onPrerequisiteFailed(@NonNull WorkInfo workInfo)
Called when a work request fails because a prerequisite work fails.
onStarted
public void onStarted(@NonNull WorkInfo workInfo)
Called when a work request starts executing i.e. ListenableWorker.startWork.
onStopped
public void onStopped(int stopReason, @NonNull WorkInfo workInfo)
Called when a work request is stopped by the system after it has started.
onUnblocked
public void onUnblocked(@NonNull WorkInfo workInfo)
Called when a work request is no longer waiting on any of its prerequisite work. If the work has no prerequisite work, this is called immediately after onEnqueued.
onUpdated
public void onUpdated(@NonNull WorkInfo oldWorkInfo, @NonNull WorkInfo updatedWorkInfo)
Called when a work request is updated from the app e.g. WorkManager.updateWork.