com.yahoo.vespa.hosted.controller.api.integration.billing.Bill Maven / Gradle / Ivy
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.integration.billing;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.CloudAccount;
import com.yahoo.config.provision.NodeResources;
import com.yahoo.config.provision.TenantName;
import com.yahoo.config.provision.zone.ZoneId;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.ZonedDateTime;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.UUID;
import java.util.function.Function;
/**
* An Bill is an identifier with a status (with history) and line items. A line item is the meat and
* potatoes of the content of the bill, and are a history of items. Most line items are connected to
* a given deployment in Vespa Cloud, but they can also be manually added to e.g. give a discount or represent
* support.
*
* All line items have a Plan associated with them - which was used to map from utilization to an actual price.
*
* The bill has a status history, but only the latest status is exposed through this API.
*
* @author ogronnesby
*/
public class Bill {
private static final BigDecimal SCALED_ZERO = new BigDecimal("0.00");
private final Id id;
private final TenantName tenant;
private final List lineItems;
private final StatusHistory statusHistory;
private final ZonedDateTime startTime;
private final ZonedDateTime endTime;
private final String exportedId;
public Bill(Id id, TenantName tenant, StatusHistory statusHistory, List lineItems,
ZonedDateTime startTime, ZonedDateTime endTime) {
this(id, tenant, statusHistory, lineItems, startTime, endTime, null);
}
public Bill(Id id, TenantName tenant, StatusHistory statusHistory, List lineItems,
ZonedDateTime startTime, ZonedDateTime endTime, String exportedId) {
this.id = id;
this.tenant = tenant;
this.lineItems = List.copyOf(lineItems);
this.statusHistory = statusHistory;
this.startTime = startTime;
this.endTime = endTime;
this.exportedId = exportedId;
}
public Id id() {
return id;
}
public TenantName tenant() {
return tenant;
}
public BillStatus status() {
return statusHistory.current();
}
public StatusHistory statusHistory() {
return statusHistory;
}
public List lineItems() {
return lineItems;
}
public ZonedDateTime getStartTime() {
return startTime;
}
public ZonedDateTime getEndTime() {
return endTime;
}
public Optional getExportedId() {
return Optional.ofNullable(exportedId);
}
public LocalDate getStartDate() {
return startTime.toLocalDate();
}
public LocalDate getEndDate() {
return endTime.minusDays(1).toLocalDate();
}
public BigDecimal sum() {
return lineItems.stream().map(LineItem::amount).reduce(SCALED_ZERO, BigDecimal::add);
}
public BigDecimal sumCpuHours() {
return sumResourceValues(LineItem::getCpuHours);
}
public BigDecimal sumMemoryHours() {
return sumResourceValues(LineItem::getMemoryHours);
}
public BigDecimal sumDiskHours() {
return sumResourceValues(LineItem::getDiskHours);
}
public BigDecimal sumCpuCost() {
return sumResourceValues(LineItem::getCpuCost);
}
public BigDecimal sumMemoryCost() {
return sumResourceValues(LineItem::getMemoryCost);
}
public BigDecimal sumDiskCost() {
return sumResourceValues(LineItem::getDiskCost);
}
public BigDecimal sumGpuCost() {
return sumResourceValues(LineItem::getGpuCost);
}
public BigDecimal sumAdditionalCost() {
// anything that is not covered by the cost for resources is "additional" costs
var resourceCosts = sumCpuCost().add(sumMemoryCost()).add(sumDiskCost()).add(sumGpuCost());
return sum().subtract(resourceCosts);
}
private BigDecimal sumResourceValues(Function> f) {
return lineItems.stream().flatMap(li -> f.apply(li).stream()).reduce(SCALED_ZERO, BigDecimal::add);
}
public static final class Id {
private final String value;
public static Id of(String value) {
Objects.requireNonNull(value);
return new Id(value);
}
public static Id generate() {
var id = UUID.randomUUID().toString();
return new Id(id);
}
private Id(String value) {
this.value = value;
}
public String value() {
return value;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Id billId = (Id) o;
return value.equals(billId.value);
}
@Override
public int hashCode() {
return Objects.hash(value);
}
@Override
public String toString() {
return "BillId{" +
"value='" + value + '\'' +
'}';
}
}
/**
* Represents a chargeable line on a bill.
*/
public static class LineItem {
private final String id;
private final String description;
private final BigDecimal amount;
private final String plan;
private final String agent;
private final ZonedDateTime addedAt;
private ZonedDateTime startedAt;
private ZonedDateTime endedAt;
private ApplicationId applicationId;
private ZoneId zoneId;
private BigDecimal cpuHours;
private BigDecimal memoryHours;
private BigDecimal diskHours;
private BigDecimal gpuHours;
private BigDecimal cpuCost;
private BigDecimal memoryCost;
private BigDecimal diskCost;
private BigDecimal gpuCost;
private NodeResources.Architecture architecture;
private int majorVersion;
private CloudAccount cloudAccount;
private String exportedId;
public LineItem(String id, String description, BigDecimal amount, String plan, String agent, ZonedDateTime addedAt) {
this.id = id;
this.description = description;
this.amount = amount;
this.plan = plan;
this.agent = agent;
this.addedAt = addedAt;
this.cloudAccount = CloudAccount.empty;
}
public LineItem(String id, String description, BigDecimal amount, String plan, String agent, ZonedDateTime addedAt,
ZonedDateTime startedAt, ZonedDateTime endedAt, ApplicationId applicationId, ZoneId zoneId,
BigDecimal cpuHours, BigDecimal memoryHours, BigDecimal diskHours, BigDecimal gpuHours, BigDecimal cpuCost,
BigDecimal memoryCost, BigDecimal diskCost, BigDecimal gpuCost, NodeResources.Architecture architecture,
int majorVersion, CloudAccount cloudAccount, String exportedId)
{
this(id, description, amount, plan, agent, addedAt);
this.startedAt = startedAt;
this.endedAt = endedAt;
if (applicationId == null && zoneId != null)
throw new IllegalArgumentException("Must supply applicationId if zoneId is supplied");
this.applicationId = applicationId;
this.zoneId = zoneId;
this.cpuHours = cpuHours;
this.memoryHours = memoryHours;
this.diskHours = diskHours;
this.gpuHours = gpuHours;
this.cpuCost = cpuCost;
this.memoryCost = memoryCost;
this.diskCost = diskCost;
this.architecture = architecture;
this.majorVersion = majorVersion;
this.gpuCost = gpuCost;
this.cloudAccount = cloudAccount;
this.exportedId = exportedId;
}
/** The opaque ID of this */
public String id() {
return id;
}
/** The string description of this - used for display purposes */
public String description() {
return description;
}
/** The dollar amount of this */
public BigDecimal amount() {
return SCALED_ZERO.add(amount);
}
/** The plan used to calculate amount of this */
public String plan() {
return plan;
}
/** Who created this line item */
public String agent() {
return agent;
}
/** When was this line item added */
public ZonedDateTime addedAt() {
return addedAt;
}
/** What time period is this line item for - time start */
public Optional startedAt() {
return Optional.ofNullable(startedAt);
}
/** What time period is this line item for - time end */
public Optional endedAt() {
return Optional.ofNullable(endedAt);
}
/** Optionally - what application is this line item about */
public Optional applicationId() {
return Optional.ofNullable(applicationId);
}
/** Optionally - what zone deployment is this line item about */
public Optional zoneId() {
return Optional.ofNullable(zoneId);
}
public Optional getCpuHours() {
return Optional.ofNullable(cpuHours);
}
public Optional getMemoryHours() {
return Optional.ofNullable(memoryHours);
}
public Optional getDiskHours() {
return Optional.ofNullable(diskHours);
}
public Optional getGpuHours() {
return Optional.ofNullable(gpuHours);
}
public Optional getCpuCost() {
return Optional.ofNullable(cpuCost);
}
public Optional getMemoryCost() {
return Optional.ofNullable(memoryCost);
}
public Optional getDiskCost() {
return Optional.ofNullable(diskCost);
}
public Optional getGpuCost() {
return Optional.ofNullable(gpuCost);
}
public Optional getArchitecture() {
return Optional.ofNullable(architecture);
}
public int getMajorVersion() {
return majorVersion;
}
public CloudAccount getCloudAccount() {
return cloudAccount;
}
public Optional getExportedId() {
return Optional.ofNullable(exportedId);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
LineItem lineItem = (LineItem) o;
return id.equals(lineItem.id) &&
description.equals(lineItem.description) &&
amount.equals(lineItem.amount) &&
plan.equals(lineItem.plan) &&
agent.equals(lineItem.agent) &&
addedAt.equals(lineItem.addedAt) &&
startedAt.equals(lineItem.startedAt) &&
endedAt.equals(lineItem.endedAt) &&
applicationId.equals(lineItem.applicationId) &&
zoneId.equals(lineItem.zoneId) &&
majorVersion == lineItem.majorVersion;
}
@Override
public int hashCode() {
return Objects.hash(id, description, amount, plan, agent, addedAt, startedAt, endedAt, applicationId, zoneId, majorVersion);
}
@Override
public String toString() {
return "LineItem{" +
"id='" + id + '\'' +
", description='" + description + '\'' +
", amount=" + amount +
", plan='" + plan + '\'' +
", agent='" + agent + '\'' +
", addedAt=" + addedAt +
", startedAt=" + startedAt +
", endedAt=" + endedAt +
", applicationId=" + applicationId +
", zoneId=" + zoneId +
'}';
}
}
}