mirror of
https://github.com/apache/cloudstack
synced 2026-08-08 15:48:29 +00:00
65 lines
2.7 KiB
Java
Executable File
65 lines
2.7 KiB
Java
Executable File
// Licensed to the Apache Software Foundation (ASF) under one
|
|
// or more contributor license agreements. See the NOTICE file
|
|
// distributed with this work for additional information
|
|
// regarding copyright ownership. The ASF licenses this file
|
|
// to you 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 org.apache.cloudstack.usage;
|
|
|
|
import java.util.List;
|
|
import java.util.TimeZone;
|
|
|
|
import org.apache.cloudstack.api.command.admin.usage.GenerateUsageRecordsCmd;
|
|
import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
|
|
import org.apache.cloudstack.api.response.UsageTypeResponse;
|
|
|
|
public interface UsageService {
|
|
/**
|
|
* Generate Billing Records from the last time it was generated to the
|
|
* time specified.
|
|
*
|
|
* @param cmd the command wrapping the generate parameters
|
|
* - userId unique id of the user, pass in -1 to generate billing records
|
|
* for all users
|
|
* - startDate
|
|
* - endDate inclusive. If date specified is greater than the current time, the
|
|
* system will use the current time.
|
|
*/
|
|
boolean generateUsageRecords(GenerateUsageRecordsCmd cmd);
|
|
|
|
/**
|
|
* Retrieves all Usage Records generated between the start and end date specified
|
|
*
|
|
* @param userId unique id of the user, pass in -1 to retrieve billing records
|
|
* for all users
|
|
* @param startDate inclusive.
|
|
* @param endDate inclusive. If date specified is greater than the current time, the
|
|
* system will use the current time.
|
|
* @param page The page of usage records to see (500 results are returned at a time, if
|
|
* more than 500 records exist then additional results can be retrieved by
|
|
* the appropriate page number)
|
|
* @return a list of usage records
|
|
*/
|
|
List<? extends Usage> getUsageRecords(GetUsageRecordsCmd cmd);
|
|
|
|
/**
|
|
* Retrieves the timezone used for usage aggregation. One day is represented as midnight to 11:59:59pm
|
|
* in the given time zone
|
|
* @return the timezone specified by the config value usage.aggregation.timezone, or GMT if null
|
|
*/
|
|
TimeZone getUsageTimezone();
|
|
|
|
List<UsageTypeResponse> listUsageTypes();
|
|
|
|
}
|
