AggregateGroupByPeriodRequest.kt
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.health.connect.client.request
import androidx.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.metadata.DataOrigin
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Period
/**
* Request object to read time bucketed aggregations for given [AggregateMetric]s in Android Health
* Platform.
*
* @param metrics Set of [AggregateMetric]s to aggregate, such as `Steps::STEPS_COUNT_TOTAL`.
* @param timeRangeFilter The [TimeRangeFilter] to read from.
* @param timeRangeSlicer The bucket size of each returned aggregate row. [timeRangeFilter] will be
* sliced into several equal-sized time buckets (except for the last one).
* @param dataOriginFilter List of [DataOrigin]s to read from, or empty for no filter.
*/
class AggregateGroupByPeriodRequest(
internal val metrics: Set<AggregateMetric<*>>,
internal val timeRangeFilter: TimeRangeFilter,
internal val timeRangeSlicer: Period,
internal val dataOriginFilter: List<DataOrigin> = emptyList(),
)