Package com.azure.quantum.jobs.models

Class Quota

java.lang.Object
com.azure.quantum.jobs.models.Quota
public final class Quota extends Object
Quota information.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Quota()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDimension()
    Get the dimension property: The name of the dimension associated with the quota.
    Float
    getHolds()
    Get the holds property: The amount of the usage that has been reserved but not applied for the current period.
    Float
    getLimit()
    Get the limit property: The maximum amount of usage allowed for the current period.
    MeterPeriod
    getPeriod()
    Get the period property: The time period in which the quota's underlying meter is accumulated.
    String
    getProviderId()
    Get the providerId property: The unique identifier for the provider.
    DimensionScope
    getScope()
    Get the scope property: The scope at which the quota is applied.
    Float
    getUtilization()
    Get the utilization property: The amount of the usage that has been applied for the current period.
    Quota
    setDimension(String dimension)
    Set the dimension property: The name of the dimension associated with the quota.
    Quota
    setHolds(Float holds)
    Set the holds property: The amount of the usage that has been reserved but not applied for the current period.
    Quota
    setLimit(Float limit)
    Set the limit property: The maximum amount of usage allowed for the current period.
    Quota
    setPeriod(MeterPeriod period)
    Set the period property: The time period in which the quota's underlying meter is accumulated.
    Quota
    setProviderId(String providerId)
    Set the providerId property: The unique identifier for the provider.
    Quota
    setScope(DimensionScope scope)
    Set the scope property: The scope at which the quota is applied.
    Quota
    setUtilization(Float utilization)
    Set the utilization property: The amount of the usage that has been applied for the current period.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Quota

      public Quota()

  • Method Details

    • getDimension

      public String getDimension()
      Get the dimension property: The name of the dimension associated with the quota.
      Returns:
      the dimension value.

    • setDimension

      public Quota setDimension(String dimension)
      Set the dimension property: The name of the dimension associated with the quota.
      Parameters:
      dimension - the dimension value to set.
      Returns:
      the Quota object itself.

    • getScope

      public DimensionScope getScope()
      Get the scope property: The scope at which the quota is applied.
      Returns:
      the scope value.

    • setScope

      public Quota setScope(DimensionScope scope)
      Set the scope property: The scope at which the quota is applied.
      Parameters:
      scope - the scope value to set.
      Returns:
      the Quota object itself.

    • getProviderId

      public String getProviderId()
      Get the providerId property: The unique identifier for the provider.
      Returns:
      the providerId value.

    • setProviderId

      public Quota setProviderId(String providerId)
      Set the providerId property: The unique identifier for the provider.
      Parameters:
      providerId - the providerId value to set.
      Returns:
      the Quota object itself.

    • getUtilization

      public Float getUtilization()
      Get the utilization property: The amount of the usage that has been applied for the current period.
      Returns:
      the utilization value.

    • setUtilization

      public Quota setUtilization(Float utilization)
      Set the utilization property: The amount of the usage that has been applied for the current period.
      Parameters:
      utilization - the utilization value to set.
      Returns:
      the Quota object itself.

    • getHolds

      public Float getHolds()
      Get the holds property: The amount of the usage that has been reserved but not applied for the current period.
      Returns:
      the holds value.

    • setHolds

      public Quota setHolds(Float holds)
      Set the holds property: The amount of the usage that has been reserved but not applied for the current period.
      Parameters:
      holds - the holds value to set.
      Returns:
      the Quota object itself.

    • getLimit

      public Float getLimit()
      Get the limit property: The maximum amount of usage allowed for the current period.
      Returns:
      the limit value.

    • setLimit

      public Quota setLimit(Float limit)
      Set the limit property: The maximum amount of usage allowed for the current period.
      Parameters:
      limit - the limit value to set.
      Returns:
      the Quota object itself.

    • getPeriod

      public MeterPeriod getPeriod()
      Get the period property: The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.
      Returns:
      the period value.

    • setPeriod

      public Quota setPeriod(MeterPeriod period)
      Set the period property: The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.
      Parameters:
      period - the period value to set.
      Returns:
      the Quota object itself.