Class FreeTierUsage

java.lang.Object
software.amazon.awssdk.services.freetier.model.FreeTierUsage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FreeTierUsage.Builder,FreeTierUsage>

@Generated("software.amazon.awssdk:codegen") public final class FreeTierUsage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FreeTierUsage.Builder,FreeTierUsage>

Consists of a Amazon Web Services Free Tier offer’s metadata and your data usage for the offer.

See Also:
  • Method Details

    • service

      public final String service()

      The name of the Amazon Web Services service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.

      Returns:
      The name of the Amazon Web Services service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.
    • operation

      public final String operation()

      Describes usageType more granularly with the specific Amazon Web Services service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud.

      Returns:
      Describes usageType more granularly with the specific Amazon Web Services service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud.
    • usageType

      public final String usageType()

      Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial.

      Returns:
      Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial.
    • region

      public final String region()

      Describes the Amazon Web Services Region for which this offer is applicable

      Returns:
      Describes the Amazon Web Services Region for which this offer is applicable
    • actualUsageAmount

      public final Double actualUsageAmount()

      Describes the actual usage accrued month-to-day (MTD) that you've used so far.

      Returns:
      Describes the actual usage accrued month-to-day (MTD) that you've used so far.
    • forecastedUsageAmount

      public final Double forecastedUsageAmount()

      Describes the forecasted usage by the month that you're expected to use.

      Returns:
      Describes the forecasted usage by the month that you're expected to use.
    • limit

      public final Double limit()

      Describes the maximum usage allowed in Free Tier.

      Returns:
      Describes the maximum usage allowed in Free Tier.
    • unit

      public final String unit()

      Describes the unit of the usageType, such as Hrs.

      Returns:
      Describes the unit of the usageType, such as Hrs.
    • description

      public final String description()

      The description of the Free Tier offer.

      Returns:
      The description of the Free Tier offer.
    • freeTierType

      public final String freeTierType()

      Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free", "Always Free", and "Free Trial".

      Returns:
      Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free", "Always Free", and "Free Trial".
    • toBuilder

      public FreeTierUsage.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FreeTierUsage.Builder,FreeTierUsage>
      Returns:
      a builder for type T
    • builder

      public static FreeTierUsage.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FreeTierUsage.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.