Class GetEstimatedWaterAllocationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sustainability.model.SustainabilityRequest
software.amazon.awssdk.services.sustainability.model.GetEstimatedWaterAllocationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetEstimatedWaterAllocationRequest extends SustainabilityRequest implements ToCopyableBuilder<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>

  • Method Details

    • timePeriod

      public final TimePeriod timePeriod()

      The date range for fetching estimated water allocation. The range must include the start date of a year for that year's data to be included in the response.

      Returns:
      The date range for fetching estimated water allocation. The range must include the start date of a year for that year's data to be included in the response.

    • groupBy

      public final List<Dimension> groupBy()

      The dimensions available for grouping estimated water allocation.

      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 hasGroupBy() method.

      Returns:
      The dimensions available for grouping estimated water allocation.

    • hasGroupBy

      public final boolean hasGroupBy()
      For responses, this returns true if the service returned a value for the GroupBy 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.

    • groupByAsStrings

      public final List<String> groupByAsStrings()

      The dimensions available for grouping estimated water allocation.

      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 hasGroupBy() method.

      Returns:
      The dimensions available for grouping estimated water allocation.

    • filterBy

      public final FilterExpression filterBy()

      The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues

      Returns:
      The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues

    • allocationTypes

      public final List<WaterAllocationType> allocationTypes()

      The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS 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 hasAllocationTypes() method.

      Returns:
      The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.

    • hasAllocationTypes

      public final boolean hasAllocationTypes()
      For responses, this returns true if the service returned a value for the AllocationTypes 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.

    • allocationTypesAsStrings

      public final List<String> allocationTypesAsStrings()

      The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS 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 hasAllocationTypes() method.

      Returns:
      The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.

    • granularity

      public final TimeGranularity granularity()

      The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

      If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

      If the service returns an enum value that is not available in the current SDK version, granularity will return TimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

      Returns:
      The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

      If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

      See Also:

    • granularityAsString

      public final String granularityAsString()

      The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

      If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

      If the service returns an enum value that is not available in the current SDK version, granularity will return TimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

      Returns:
      The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

      If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call. Default is 1000.

      Returns:
      The maximum number of results to return in a single call. Default is 1000.

    • nextToken

      public final String nextToken()

      The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

      Returns:
      The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

    • toBuilder

      public GetEstimatedWaterAllocationRequest.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<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>
      Specified by:
      toBuilder in class SustainabilityRequest
      Returns:
      a builder for type T

    • builder

      public static GetEstimatedWaterAllocationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEstimatedWaterAllocationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.