1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.cobalt;
18 
19 import com.google.common.util.concurrent.ListenableFuture;
20 
21 /**
22  * The API for periodic work in Cobalt that can be called from some work scheduling framework.
23  *
24  * <p>This API should be ideally be called by clients 3-4 times per day and no less than 1 time per
25  * day to ensure data is aggregated and sent to Cobalt's backend.
26  */
27 public interface CobaltPeriodicJob {
28 
29     /**
30      * Generates observations from aggregated data, encrypts them, and send them to Cobalt's
31      * backend.
32      *
33      * @return a ListenableFuture that can be used to determine when observation generation is
34      *     complete
35      */
generateAggregatedObservations()36     ListenableFuture<Void> generateAggregatedObservations();
37 }
38