// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.billingbenefits.models;

import com.azure.core.management.SystemData;
import com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanModelInner;
import java.time.OffsetDateTime;

/** An immutable client-side representation of SavingsPlanModel. */
public interface SavingsPlanModel {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     *
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     *
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     *
     * @return the type value.
     */
    String type();

    /**
     * Gets the sku property: Savings plan SKU.
     *
     * @return the sku value.
     */
    Sku sku();

    /**
     * Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the displayName property: Display name.
     *
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the provisioningState property: Provisioning state.
     *
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the displayProvisioningState property: The provisioning state of the savings plan for display, e.g.
     * Succeeded.
     *
     * @return the displayProvisioningState value.
     */
    String displayProvisioningState();

    /**
     * Gets the billingScopeId property: Subscription that will be charged for purchasing the benefit.
     *
     * @return the billingScopeId value.
     */
    String billingScopeId();

    /**
     * Gets the billingProfileId property: Fully-qualified identifier of the billing profile where the savings plan is
     * applied. Present only for Field-led or Customer-led customers.
     *
     * @return the billingProfileId value.
     */
    String billingProfileId();

    /**
     * Gets the customerId property: Fully-qualified identifier of the customer where the savings plan is applied.
     * Present only for Partner-led customers.
     *
     * @return the customerId value.
     */
    String customerId();

    /**
     * Gets the billingAccountId property: Fully-qualified identifier of the billing account where the savings plan is
     * applied. Present only for Enterprise Agreement customers.
     *
     * @return the billingAccountId value.
     */
    String billingAccountId();

    /**
     * Gets the term property: Represent benefit term in ISO 8601 format.
     *
     * @return the term value.
     */
    Term term();

    /**
     * Gets the billingPlan property: Represents the billing plan in ISO 8601 format. Required only for monthly billing
     * plans.
     *
     * @return the billingPlan value.
     */
    BillingPlan billingPlan();

    /**
     * Gets the appliedScopeType property: Type of the Applied Scope.
     *
     * @return the appliedScopeType value.
     */
    AppliedScopeType appliedScopeType();

    /**
     * Gets the userFriendlyAppliedScopeType property: The applied scope type of the savings plan for display, e.g.
     * Shared.
     *
     * @return the userFriendlyAppliedScopeType value.
     */
    String userFriendlyAppliedScopeType();

    /**
     * Gets the appliedScopeProperties property: Properties specific to applied scope type. Not required if not
     * applicable.
     *
     * @return the appliedScopeProperties value.
     */
    AppliedScopeProperties appliedScopeProperties();

    /**
     * Gets the commitment property: Commitment towards the benefit.
     *
     * @return the commitment value.
     */
    Commitment commitment();

    /**
     * Gets the effectiveDateTime property: DateTime of the savings plan starts providing benefit from.
     *
     * @return the effectiveDateTime value.
     */
    OffsetDateTime effectiveDateTime();

    /**
     * Gets the expiryDateTime property: Expiry date time.
     *
     * @return the expiryDateTime value.
     */
    OffsetDateTime expiryDateTime();

    /**
     * Gets the purchaseDateTime property: Date time when the savings plan was purchased.
     *
     * @return the purchaseDateTime value.
     */
    OffsetDateTime purchaseDateTime();

    /**
     * Gets the benefitStartTime property: This is the DateTime when the savings plan benefit started.
     *
     * @return the benefitStartTime value.
     */
    OffsetDateTime benefitStartTime();

    /**
     * Gets the extendedStatusInfo property: The extendedStatusInfo property.
     *
     * @return the extendedStatusInfo value.
     */
    ExtendedStatusInfo extendedStatusInfo();

    /**
     * Gets the renew property: Setting this to true will automatically purchase a new benefit on the expiration date
     * time.
     *
     * @return the renew value.
     */
    Boolean renew();

    /**
     * Gets the utilization property: Savings plan utilization.
     *
     * @return the utilization value.
     */
    Utilization utilization();

    /**
     * Gets the renewSource property: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
     *
     * @return the renewSource value.
     */
    String renewSource();

    /**
     * Gets the renewDestination property: SavingsPlan Id of the SavingsPlan which is purchased because of renew.
     *
     * @return the renewDestination value.
     */
    String renewDestination();

    /**
     * Gets the renewProperties property: The renewProperties property.
     *
     * @return the renewProperties value.
     */
    RenewProperties renewProperties();

    /**
     * Gets the inner com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanModelInner object.
     *
     * @return the inner object.
     */
    SavingsPlanModelInner innerModel();
}
