Class EstimatedWaterAllocation

java.lang.Object
software.amazon.awssdk.services.sustainability.model.EstimatedWaterAllocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EstimatedWaterAllocation.Builder,EstimatedWaterAllocation>
@Generated("software.amazon.awssdk:codegen") public final class EstimatedWaterAllocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EstimatedWaterAllocation.Builder,EstimatedWaterAllocation>

Contains estimated water allocation data for a specific time period and dimension grouping.

See Also:

  • Method Details

    • timePeriod

      public final TimePeriod timePeriod()

      The reporting period for water allocation values.

      Returns:
      The reporting period for water allocation values.

    • dimensionsValues

      public final Map<Dimension,String> dimensionsValues()

      The dimensions used to group water allocation values.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensionsValues() method.

      Returns:
      The dimensions used to group water allocation values.

    • hasDimensionsValues

      public final boolean hasDimensionsValues()
      For responses, this returns true if the service returned a value for the DimensionsValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dimensionsValuesAsStrings

      public final Map<String,String> dimensionsValuesAsStrings()

      The dimensions used to group water allocation values.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensionsValues() method.

      Returns:
      The dimensions used to group water allocation values.

    • modelVersion

      public final String modelVersion()

      The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values.

      The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different ModelVersion values.

      Returns:
      The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values.

      The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different ModelVersion values.

    • allocationValues

      public final Map<WaterAllocationType,WaterAllocation> allocationValues()

      The allocation values for the requested water allocation types.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllocationValues() method.

      Returns:
      The allocation values for the requested water allocation types.

    • hasAllocationValues

      public final boolean hasAllocationValues()
      For responses, this returns true if the service returned a value for the AllocationValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • allocationValuesAsStrings

      public final Map<String,WaterAllocation> allocationValuesAsStrings()

      The allocation values for the requested water allocation types.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllocationValues() method.

      Returns:
      The allocation values for the requested water allocation types.

    • toBuilder

      public EstimatedWaterAllocation.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<EstimatedWaterAllocation.Builder,EstimatedWaterAllocation>
      Returns:
      a builder for type T

    • builder

      public static EstimatedWaterAllocation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EstimatedWaterAllocation.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.