ReservationInner Class

Package:

com.azure.resourcemanager.billing.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.billing.fluent.models.ReservationInner

public final class ReservationInner
extends ProxyResource

The definition of the reservation.

Constructor Summary

Constructor	Description
ReservationInner()	Creates an instance of ReservationInner class.

Method Summary

Modifier and Type	Method and Description
List<ReservationUtilizationAggregates>	aggregates() Get the aggregates property: The array of aggregates of a reservation's utilization.
ReservationAppliedScopeProperties	appliedScopeProperties() Get the appliedScopeProperties property: Properties specific to applied scope type.
List<String>	appliedScopes() Get the appliedScopes property: The array of applied scopes of a reservation.
String	appliedScopeType() Get the appliedScopeType property: The applied scope type of the reservation.
Boolean	archived() Get the archived property: Indicates if the reservation is archived.
OffsetDateTime	benefitStartTime() Get the benefitStartTime property: This is the DateTime when the reservation benefit started.
ReservationBillingPlan	billingPlan() Get the billingPlan property: The billing plan options available for this sku.
String	billingScopeId() Get the billingScopeId property: Subscription that will be charged for purchasing reservation or savings plan.
String	capabilities() Get the capabilities property: Capabilities of the reservation.
String	displayName() Get the displayName property: The display name of the reservation.
String	displayProvisioningState() Get the displayProvisioningState property: The provisioning state of the reservation for display, e.g.
OffsetDateTime	effectiveDateTime() Get the effectiveDateTime property: The effective date time of the reservation.
Integer	etag() Get the etag property: The etag property.
String	expiryDate() Get the expiryDate property: The expiry date of the reservation.
OffsetDateTime	expiryDateTime() Get the expiryDateTime property: This is the date-time when the reservation will expire.
ReservationExtendedStatusInfo	extendedStatusInfo() Get the extendedStatusInfo property: The message giving detailed information about the status code.
static ReservationInner	fromJson(JsonReader jsonReader) Reads an instance of ReservationInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
InstanceFlexibility	instanceFlexibility() Get the instanceFlexibility property: Allows reservation discount to be applied across skus within the same auto fit group.
OffsetDateTime	lastUpdatedDateTime() Get the lastUpdatedDateTime property: DateTime of the last time the reservation was updated.
String	location() Get the location property: The location of the reservation.
ReservationMergeProperties	mergeProperties() Get the mergeProperties property: Properties of reservation merge.
String	name() Get the name property: The name of the resource.
String	productCode() Get the productCode property: Represents UPN.
String	provisioningState() Get the provisioningState property: The provisioning state of the reservation, e.g.
String	provisioningSubState() Get the provisioningSubState property: The provisioning state of the reservation, e.g.
LocalDate	purchaseDate() Get the purchaseDate property: This is the date when the reservation was purchased.
OffsetDateTime	purchaseDateTime() Get the purchaseDateTime property: This is the date-time when the reservation was purchased.
Float	quantity() Get the quantity property: The number of the reservation.
Boolean	renew() Get the renew property: The renew state of the reservation.
String	renewDestination() Get the renewDestination property: Reservation Id of the reservation which is purchased because of renew.
RenewPropertiesResponse	renewProperties() Get the renewProperties property: The renew properties for a reservation.
String	renewSource() Get the renewSource property: The renew source of the reservation.
String	reservedResourceType() Get the reservedResourceType property: The reserved source type of the reservation, e.g.
OffsetDateTime	reviewDateTime() Get the reviewDateTime property: This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
ReservationSkuProperty	sku() Get the sku property: The sku information associated to this reservation.
String	skuDescription() Get the skuDescription property: The sku description of the reservation.
ReservationSplitProperties	splitProperties() Get the splitProperties property: Properties of reservation split.
ReservationSwapProperties	swapProperties() Get the swapProperties property: Properties of reservation swap.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Map<String,String>	tags() Get the tags property: Tags for this reservation.
String	term() Get the term property: The term of the reservation, e.g.
JsonWriter	toJson(JsonWriter jsonWriter)
String	trend() Get the trend property: last 7 day utilization trend for a reservation.
String	type() Get the type property: The type of the resource.
String	userFriendlyAppliedScopeType() Get the userFriendlyAppliedScopeType property: The applied scope type of the reservation for display, e.g.
String	userFriendlyRenewState() Get the userFriendlyRenewState property: The renew state of the reservation for display, e.g.
void	validate() Validates the instance.
ReservationInner	withAppliedScopeProperties(ReservationAppliedScopeProperties appliedScopeProperties) Set the appliedScopeProperties property: Properties specific to applied scope type.
ReservationInner	withAppliedScopes(List<String> appliedScopes) Set the appliedScopes property: The array of applied scopes of a reservation.
ReservationInner	withArchived(Boolean archived) Set the archived property: Indicates if the reservation is archived.
ReservationInner	withBenefitStartTime(OffsetDateTime benefitStartTime) Set the benefitStartTime property: This is the DateTime when the reservation benefit started.
ReservationInner	withBillingPlan(ReservationBillingPlan billingPlan) Set the billingPlan property: The billing plan options available for this sku.
ReservationInner	withCapabilities(String capabilities) Set the capabilities property: Capabilities of the reservation.
ReservationInner	withEtag(Integer etag) Set the etag property: The etag property.
ReservationInner	withExpiryDateTime(OffsetDateTime expiryDateTime) Set the expiryDateTime property: This is the date-time when the reservation will expire.
ReservationInner	withExtendedStatusInfo(ReservationExtendedStatusInfo extendedStatusInfo) Set the extendedStatusInfo property: The message giving detailed information about the status code.
ReservationInner	withInstanceFlexibility(InstanceFlexibility instanceFlexibility) Set the instanceFlexibility property: Allows reservation discount to be applied across skus within the same auto fit group.
ReservationInner	withLocation(String location) Set the location property: The location of the reservation.
ReservationInner	withMergeProperties(ReservationMergeProperties mergeProperties) Set the mergeProperties property: Properties of reservation merge.
ReservationInner	withProductCode(String productCode) Set the productCode property: Represents UPN.
ReservationInner	withPurchaseDate(LocalDate purchaseDate) Set the purchaseDate property: This is the date when the reservation was purchased.
ReservationInner	withPurchaseDateTime(OffsetDateTime purchaseDateTime) Set the purchaseDateTime property: This is the date-time when the reservation was purchased.
ReservationInner	withRenewDestination(String renewDestination) Set the renewDestination property: Reservation Id of the reservation which is purchased because of renew.
ReservationInner	withRenewProperties(RenewPropertiesResponse renewProperties) Set the renewProperties property: The renew properties for a reservation.
ReservationInner	withReviewDateTime(OffsetDateTime reviewDateTime) Set the reviewDateTime property: This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
ReservationInner	withSku(ReservationSkuProperty sku) Set the sku property: The sku information associated to this reservation.
ReservationInner	withSplitProperties(ReservationSplitProperties splitProperties) Set the splitProperties property: Properties of reservation split.
ReservationInner	withSwapProperties(ReservationSwapProperties swapProperties) Set the swapProperties property: Properties of reservation swap.
ReservationInner	withTags(Map<String,String> tags) Set the tags property: Tags for this reservation.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ReservationInner

public ReservationInner()

Creates an instance of ReservationInner class.

Method Details

aggregates

public List<ReservationUtilizationAggregates> aggregates()

Get the aggregates property: The array of aggregates of a reservation's utilization.

Returns:

the aggregates value.

appliedScopeProperties

public ReservationAppliedScopeProperties appliedScopeProperties()

Get the appliedScopeProperties property: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup.

Returns:

the appliedScopeProperties value.

appliedScopes

public List<String> appliedScopes()

Get the appliedScopes property: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.

Returns:

the appliedScopes value.

appliedScopeType

public String appliedScopeType()

Get the appliedScopeType property: The applied scope type of the reservation.

Returns:

the appliedScopeType value.

archived

public Boolean archived()

Get the archived property: Indicates if the reservation is archived.

Returns:

the archived value.

benefitStartTime

public OffsetDateTime benefitStartTime()

Get the benefitStartTime property: This is the DateTime when the reservation benefit started.

Returns:

the benefitStartTime value.

billingPlan

public ReservationBillingPlan billingPlan()

Get the billingPlan property: The billing plan options available for this sku.

Returns:

the billingPlan value.

billingScopeId

public String billingScopeId()

Get the billingScopeId property: Subscription that will be charged for purchasing reservation or savings plan.

Returns:

the billingScopeId value.

capabilities

public String capabilities()

Get the capabilities property: Capabilities of the reservation.

Returns:

the capabilities value.

displayName

public String displayName()

Get the displayName property: The display name of the reservation.

Returns:

the displayName value.

displayProvisioningState

public String displayProvisioningState()

Get the displayProvisioningState property: The provisioning state of the reservation for display, e.g. Succeeded.

Returns:

the displayProvisioningState value.

effectiveDateTime

public OffsetDateTime effectiveDateTime()

Get the effectiveDateTime property: The effective date time of the reservation.

Returns:

the effectiveDateTime value.

etag

public Integer etag()

Get the etag property: The etag property.

Returns:

the etag value.

expiryDate

public String expiryDate()

Get the expiryDate property: The expiry date of the reservation.

Returns:

the expiryDate value.

expiryDateTime

public OffsetDateTime expiryDateTime()

Get the expiryDateTime property: This is the date-time when the reservation will expire.

Returns:

the expiryDateTime value.

extendedStatusInfo

public ReservationExtendedStatusInfo extendedStatusInfo()

Get the extendedStatusInfo property: The message giving detailed information about the status code.

Returns:

the extendedStatusInfo value.

fromJson

public static ReservationInner fromJson(JsonReader jsonReader)

Reads an instance of ReservationInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ReservationInner.id()

Returns:

the id value.

instanceFlexibility

public InstanceFlexibility instanceFlexibility()

Get the instanceFlexibility property: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.

Returns:

the instanceFlexibility value.

lastUpdatedDateTime

public OffsetDateTime lastUpdatedDateTime()

Get the lastUpdatedDateTime property: DateTime of the last time the reservation was updated.

Returns:

the lastUpdatedDateTime value.

location

public String location()

Get the location property: The location of the reservation.

Returns:

the location value.

mergeProperties

public ReservationMergeProperties mergeProperties()

Get the mergeProperties property: Properties of reservation merge.

Returns:

the mergeProperties value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ReservationInner.name()

Returns:

the name value.

productCode

public String productCode()

Get the productCode property: Represents UPN.

Returns:

the productCode value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state of the reservation, e.g. Succeeded.

Returns:

the provisioningState value.

provisioningSubState

public String provisioningSubState()

Get the provisioningSubState property: The provisioning state of the reservation, e.g. Succeeded.

Returns:

the provisioningSubState value.

purchaseDate

public LocalDate purchaseDate()

Get the purchaseDate property: This is the date when the reservation was purchased.

Returns:

the purchaseDate value.

purchaseDateTime

public OffsetDateTime purchaseDateTime()

Get the purchaseDateTime property: This is the date-time when the reservation was purchased.

Returns:

the purchaseDateTime value.

quantity

public Float quantity()

Get the quantity property: The number of the reservation.

Returns:

the quantity value.

renew

public Boolean renew()

Get the renew property: The renew state of the reservation.

Returns:

the renew value.

renewDestination

public String renewDestination()

Get the renewDestination property: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

Returns:

the renewDestination value.

renewProperties

public RenewPropertiesResponse renewProperties()

Get the renewProperties property: The renew properties for a reservation.

Returns:

the renewProperties value.

renewSource

public String renewSource()

Get the renewSource property: The renew source of the reservation.

Returns:

the renewSource value.

reservedResourceType

public String reservedResourceType()

Get the reservedResourceType property: The reserved source type of the reservation, e.g. virtual machine.

Returns:

the reservedResourceType value.

reviewDateTime

public OffsetDateTime reviewDateTime()

Get the reviewDateTime property: This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

Returns:

the reviewDateTime value.

sku

public ReservationSkuProperty sku()

Get the sku property: The sku information associated to this reservation.

Returns:

the sku value.

skuDescription

public String skuDescription()

Get the skuDescription property: The sku description of the reservation.

Returns:

the skuDescription value.

splitProperties

public ReservationSplitProperties splitProperties()

Get the splitProperties property: Properties of reservation split.

Returns:

the splitProperties value.

swapProperties

public ReservationSwapProperties swapProperties()

Get the swapProperties property: Properties of reservation swap.

Returns:

the swapProperties value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public Map<String,String> tags()

Get the tags property: Tags for this reservation.

Returns:

the tags value.

term

public String term()

Get the term property: The term of the reservation, e.g. P1Y.

Returns:

the term value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ReservationInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

trend

public String trend()

Get the trend property: last 7 day utilization trend for a reservation.

Returns:

the trend value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

ReservationInner.type()

Returns:

the type value.

userFriendlyAppliedScopeType

public String userFriendlyAppliedScopeType()

Get the userFriendlyAppliedScopeType property: The applied scope type of the reservation for display, e.g. Shared.

Returns:

the userFriendlyAppliedScopeType value.

userFriendlyRenewState

public String userFriendlyRenewState()

Get the userFriendlyRenewState property: The renew state of the reservation for display, e.g. On.

Returns:

the userFriendlyRenewState value.

validate

public void validate()

Validates the instance.

withAppliedScopeProperties

public ReservationInner withAppliedScopeProperties(ReservationAppliedScopeProperties appliedScopeProperties)

Set the appliedScopeProperties property: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup.

Parameters:

appliedScopeProperties - the appliedScopeProperties value to set.

Returns:

the ReservationInner object itself.

withAppliedScopes

public ReservationInner withAppliedScopes(List<String> appliedScopes)

Set the appliedScopes property: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.

Parameters:

appliedScopes - the appliedScopes value to set.

Returns:

the ReservationInner object itself.

withArchived

public ReservationInner withArchived(Boolean archived)

Set the archived property: Indicates if the reservation is archived.

Parameters:

archived - the archived value to set.

Returns:

the ReservationInner object itself.

withBenefitStartTime

public ReservationInner withBenefitStartTime(OffsetDateTime benefitStartTime)

Set the benefitStartTime property: This is the DateTime when the reservation benefit started.

Parameters:

benefitStartTime - the benefitStartTime value to set.

Returns:

the ReservationInner object itself.

withBillingPlan

public ReservationInner withBillingPlan(ReservationBillingPlan billingPlan)

Set the billingPlan property: The billing plan options available for this sku.

Parameters:

billingPlan - the billingPlan value to set.

Returns:

the ReservationInner object itself.

withCapabilities

public ReservationInner withCapabilities(String capabilities)

Set the capabilities property: Capabilities of the reservation.

Parameters:

capabilities - the capabilities value to set.

Returns:

the ReservationInner object itself.

withEtag

public ReservationInner withEtag(Integer etag)

Set the etag property: The etag property.

Parameters:

etag - the etag value to set.

Returns:

the ReservationInner object itself.

withExpiryDateTime

public ReservationInner withExpiryDateTime(OffsetDateTime expiryDateTime)

Set the expiryDateTime property: This is the date-time when the reservation will expire.

Parameters:

expiryDateTime - the expiryDateTime value to set.

Returns:

the ReservationInner object itself.

withExtendedStatusInfo

public ReservationInner withExtendedStatusInfo(ReservationExtendedStatusInfo extendedStatusInfo)

Set the extendedStatusInfo property: The message giving detailed information about the status code.

Parameters:

extendedStatusInfo - the extendedStatusInfo value to set.

Returns:

the ReservationInner object itself.

withInstanceFlexibility

public ReservationInner withInstanceFlexibility(InstanceFlexibility instanceFlexibility)

Set the instanceFlexibility property: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.

Parameters:

instanceFlexibility - the instanceFlexibility value to set.

Returns:

the ReservationInner object itself.

withLocation

public ReservationInner withLocation(String location)

Set the location property: The location of the reservation.

Parameters:

location - the location value to set.

Returns:

the ReservationInner object itself.

withMergeProperties

public ReservationInner withMergeProperties(ReservationMergeProperties mergeProperties)

Set the mergeProperties property: Properties of reservation merge.

Parameters:

mergeProperties - the mergeProperties value to set.

Returns:

the ReservationInner object itself.

withProductCode

public ReservationInner withProductCode(String productCode)

Set the productCode property: Represents UPN.

Parameters:

productCode - the productCode value to set.

Returns:

the ReservationInner object itself.

withPurchaseDate

public ReservationInner withPurchaseDate(LocalDate purchaseDate)

Set the purchaseDate property: This is the date when the reservation was purchased.

Parameters:

purchaseDate - the purchaseDate value to set.

Returns:

the ReservationInner object itself.

withPurchaseDateTime

public ReservationInner withPurchaseDateTime(OffsetDateTime purchaseDateTime)

Set the purchaseDateTime property: This is the date-time when the reservation was purchased.

Parameters:

purchaseDateTime - the purchaseDateTime value to set.

Returns:

the ReservationInner object itself.

withRenewDestination

public ReservationInner withRenewDestination(String renewDestination)

Set the renewDestination property: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

Parameters:

renewDestination - the renewDestination value to set.

Returns:

the ReservationInner object itself.

withRenewProperties

public ReservationInner withRenewProperties(RenewPropertiesResponse renewProperties)

Set the renewProperties property: The renew properties for a reservation.

Parameters:

renewProperties - the renewProperties value to set.

Returns:

the ReservationInner object itself.

withReviewDateTime

public ReservationInner withReviewDateTime(OffsetDateTime reviewDateTime)

Set the reviewDateTime property: This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

Parameters:

reviewDateTime - the reviewDateTime value to set.

Returns:

the ReservationInner object itself.

withSku

public ReservationInner withSku(ReservationSkuProperty sku)

Set the sku property: The sku information associated to this reservation.

Parameters:

sku - the sku value to set.

Returns:

the ReservationInner object itself.

withSplitProperties

public ReservationInner withSplitProperties(ReservationSplitProperties splitProperties)

Set the splitProperties property: Properties of reservation split.

Parameters:

splitProperties - the splitProperties value to set.

Returns:

the ReservationInner object itself.

withSwapProperties

public ReservationInner withSwapProperties(ReservationSwapProperties swapProperties)

Set the swapProperties property: Properties of reservation swap.

Parameters:

swapProperties - the swapProperties value to set.

Returns:

the ReservationInner object itself.

withTags

public ReservationInner withTags(Map<String,String> tags)

Set the tags property: Tags for this reservation.

Parameters:

tags - the tags value to set.

Returns:

the ReservationInner object itself.