com.azure.resourcemanager.costmanagement.models.SavingsPlanUtilizationSummary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-costmanagement Show documentation
This package contains Microsoft Azure SDK for CostManagement Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions. Package tag package-2022-10.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.costmanagement.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.costmanagement.fluent.models.BenefitUtilizationSummaryInner;
import com.azure.resourcemanager.costmanagement.fluent.models.SavingsPlanUtilizationSummaryProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;
import java.math.BigDecimal;
import java.time.OffsetDateTime;

/** Savings plan utilization summary resource. */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "kind")
@JsonTypeName("SavingsPlan")
@Fluent
public final class SavingsPlanUtilizationSummary extends BenefitUtilizationSummaryInner {
    /*
     * Savings plan utilization summary properties.
     */
    @JsonProperty(value = "properties")
    private SavingsPlanUtilizationSummaryProperties innerProperties;

    /** Creates an instance of SavingsPlanUtilizationSummary class. */
    public SavingsPlanUtilizationSummary() {
    }

    /**
     * Get the innerProperties property: Savings plan utilization summary properties.
     *
     * @return the innerProperties value.
     */
    private SavingsPlanUtilizationSummaryProperties innerProperties() {
        return this.innerProperties;
    }

    /**
     * Get the avgUtilizationPercentage property: This is the average hourly utilization for each date range that
     * corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate
     * < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day,
     * the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24
     * utilization percentage entries one for each hour in a specific day.
     *
     * @return the avgUtilizationPercentage value.
     */
    public BigDecimal avgUtilizationPercentage() {
        return this.innerProperties() == null ? null : this.innerProperties().avgUtilizationPercentage();
    }

    /**
     * Get the minUtilizationPercentage property: This is the minimum hourly utilization for each date range that
     * corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate
     * < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day,
     * the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24
     * utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest
     * utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be
     * 10%.
     *
     * @return the minUtilizationPercentage value.
     */
    public BigDecimal minUtilizationPercentage() {
        return this.innerProperties() == null ? null : this.innerProperties().minUtilizationPercentage();
    }

    /**
     * Get the maxUtilizationPercentage property: This is the maximum hourly utilization for each date range that
     * corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate
     * < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day,
     * the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24
     * utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest
     * utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be
     * 90%.
     *
     * @return the maxUtilizationPercentage value.
     */
    public BigDecimal maxUtilizationPercentage() {
        return this.innerProperties() == null ? null : this.innerProperties().maxUtilizationPercentage();
    }

    /**
     * Get the armSkuName property: ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.
     *
     * @return the armSkuName value.
     */
    public String armSkuName() {
        return this.innerProperties() == null ? null : this.innerProperties().armSkuName();
    }

    /**
     * Get the benefitId property: The benefit ID is the identifier of the benefit.
     *
     * @return the benefitId value.
     */
    public String benefitId() {
        return this.innerProperties() == null ? null : this.innerProperties().benefitId();
    }

    /**
     * Get the benefitOrderId property: The benefit order ID is the identifier for a benefit purchase.
     *
     * @return the benefitOrderId value.
     */
    public String benefitOrderId() {
        return this.innerProperties() == null ? null : this.innerProperties().benefitOrderId();
    }

    /**
     * Get the benefitType property: The benefit type. Supported values: 'SavingsPlan'.
     *
     * @return the benefitType value.
     */
    public BenefitKind benefitType() {
        return this.innerProperties() == null ? null : this.innerProperties().benefitType();
    }

    /**
     * Set the benefitType property: The benefit type. Supported values: 'SavingsPlan'.
     *
     * @param benefitType the benefitType value to set.
     * @return the SavingsPlanUtilizationSummary object itself.
     */
    public SavingsPlanUtilizationSummary withBenefitType(BenefitKind benefitType) {
        if (this.innerProperties() == null) {
            this.innerProperties = new SavingsPlanUtilizationSummaryProperties();
        }
        this.innerProperties().withBenefitType(benefitType);
        return this;
    }

    /**
     * Get the usageDate property: Date corresponding to the utilization summary record. If the grain of data is
     * monthly, value for this field will be first day of the month.
     *
     * @return the usageDate value.
     */
    public OffsetDateTime usageDate() {
        return this.innerProperties() == null ? null : this.innerProperties().usageDate();
    }

    /**
     * Validates the instance.
     *
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    @Override
    public void validate() {
        super.validate();
        if (innerProperties() != null) {
            innerProperties().validate();
        }
    }
}