ReservationSummaryProperties Class

Package:
com.azure.resourcemanager.consumption.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0
  • java.lang.Object
    • com.azure.resourcemanager.consumption.fluent.models.ReservationSummaryProperties

Implements

JsonSerializable<ReservationSummaryProperties>

public final class ReservationSummaryProperties
implements JsonSerializable<ReservationSummaryProperties>

The properties of the reservation summary.

Constructor Summary

Constructor Description
ReservationSummaryProperties()

Creates an instance of ReservationSummaryProperties class.

Method Summary

Modifier and Type Method and Description
BigDecimal avgUtilizationPercentage()

Get the avgUtilizationPercentage property: This is average utilization for the entire time range.
static ReservationSummaryProperties fromJson(JsonReader jsonReader)

Reads an instance of ReservationSummaryProperties from the JsonReader.
String kind()

Get the kind property: The reservation kind.
BigDecimal maxUtilizationPercentage()

Get the maxUtilizationPercentage property: This is the maximum hourly utilization in the usage time (day or month).
BigDecimal minUtilizationPercentage()

Get the minUtilizationPercentage property: This is the minimum hourly utilization in the usage time (day or month).
BigDecimal purchasedQuantity()

Get the purchasedQuantity property: This is the purchased quantity for the reservationId.
BigDecimal remainingQuantity()

Get the remainingQuantity property: This is the remaining quantity for the reservationId.
String reservationId()

Get the reservationId property: The reservation ID is the identifier of a reservation within a reservation order.
String reservationOrderId()

Get the reservationOrderId property: The reservation order ID is the identifier for a reservation purchase.
BigDecimal reservedHours()

Get the reservedHours property: This is the total hours reserved.
String skuName()

Get the skuName property: This is the ARM Sku name.
JsonWriter toJson(JsonWriter jsonWriter)
BigDecimal totalReservedQuantity()

Get the totalReservedQuantity property: This is the total count of instances that are reserved for the reservationId.
OffsetDateTime usageDate()

Get the usageDate property: Data corresponding to the utilization record.
BigDecimal usedHours()

Get the usedHours property: Total used hours by the reservation.
BigDecimal usedQuantity()

Get the usedQuantity property: This is the used quantity for the reservationId.
BigDecimal utilizedPercentage()

Get the utilizedPercentage property: This is the utilized percentage for the reservation Id.
void validate()

Validates the instance.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ReservationSummaryProperties

public ReservationSummaryProperties()

Creates an instance of ReservationSummaryProperties class.

Method Details

avgUtilizationPercentage

public BigDecimal avgUtilizationPercentage()

Get the avgUtilizationPercentage property: This is average utilization for the entire time range. (day or month depending on the grain).

Returns:

the avgUtilizationPercentage value.

fromJson

public static ReservationSummaryProperties fromJson(JsonReader jsonReader)

Reads an instance of ReservationSummaryProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ReservationSummaryProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ReservationSummaryProperties.

kind

public String kind()

Get the kind property: The reservation kind.

Returns:

the kind value.

maxUtilizationPercentage

public BigDecimal maxUtilizationPercentage()

Get the maxUtilizationPercentage property: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

Returns:

the maxUtilizationPercentage value.

minUtilizationPercentage

public BigDecimal minUtilizationPercentage()

Get the minUtilizationPercentage property: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day.

Returns:

the minUtilizationPercentage value.

purchasedQuantity

public BigDecimal purchasedQuantity()

Get the purchasedQuantity property: This is the purchased quantity for the reservationId.

Returns:

the purchasedQuantity value.

remainingQuantity

public BigDecimal remainingQuantity()

Get the remainingQuantity property: This is the remaining quantity for the reservationId.

Returns:

the remainingQuantity value.

reservationId

public String reservationId()

Get the reservationId property: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.

Returns:

the reservationId value.

reservationOrderId

public String reservationOrderId()

Get the reservationOrderId property: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.

Returns:

the reservationOrderId value.

reservedHours

public BigDecimal reservedHours()

Get the reservedHours property: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.

Returns:

the reservedHours value.

skuName

public String skuName()

Get the skuName property: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.

Returns:

the skuName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

totalReservedQuantity

public BigDecimal totalReservedQuantity()

Get the totalReservedQuantity property: This is the total count of instances that are reserved for the reservationId.

Returns:

the totalReservedQuantity value.

usageDate

public OffsetDateTime usageDate()

Get the usageDate property: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.

Returns:

the usageDate value.

usedHours

public BigDecimal usedHours()

Get the usedHours property: Total used hours by the reservation.

Returns:

the usedHours value.

usedQuantity

public BigDecimal usedQuantity()

Get the usedQuantity property: This is the used quantity for the reservationId.

Returns:

the usedQuantity value.

utilizedPercentage

public BigDecimal utilizedPercentage()

Get the utilizedPercentage property: This is the utilized percentage for the reservation Id.

Returns:

the utilizedPercentage value.

validate

public void validate()

Validates the instance.

Applies to