Interface GetEstimatedWaterAllocationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>, SdkBuilder<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>, SdkPojo, SdkRequest.Builder, SustainabilityRequest.Builder
Enclosing class:
GetEstimatedWaterAllocationRequest
@Mutable @NotThreadSafe public static interface GetEstimatedWaterAllocationRequest.Builder extends SustainabilityRequest.Builder, SdkPojo, CopyableBuilder<GetEstimatedWaterAllocationRequest.Builder,GetEstimatedWaterAllocationRequest>

  • Method Details

    • timePeriod

      GetEstimatedWaterAllocationRequest.Builder timePeriod(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timePeriod

      default GetEstimatedWaterAllocationRequest.Builder timePeriod(Consumer<TimePeriod.Builder> 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.

      This is a convenience method that creates an instance of the TimePeriod.Builder avoiding the need to create one manually via TimePeriod.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(TimePeriod).

      Parameters:
      timePeriod - a consumer that will call methods on TimePeriod.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupByWithStrings

      GetEstimatedWaterAllocationRequest.Builder groupByWithStrings(Collection<String> groupBy)

      The dimensions available for grouping estimated water allocation.

      Parameters:
      groupBy - The dimensions available for grouping estimated water allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupByWithStrings

      GetEstimatedWaterAllocationRequest.Builder groupByWithStrings(String... groupBy)

      The dimensions available for grouping estimated water allocation.

      Parameters:
      groupBy - The dimensions available for grouping estimated water allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetEstimatedWaterAllocationRequest.Builder groupBy(Collection<Dimension> groupBy)

      The dimensions available for grouping estimated water allocation.

      Parameters:
      groupBy - The dimensions available for grouping estimated water allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetEstimatedWaterAllocationRequest.Builder groupBy(Dimension... groupBy)

      The dimensions available for grouping estimated water allocation.

      Parameters:
      groupBy - The dimensions available for grouping estimated water allocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterBy

      GetEstimatedWaterAllocationRequest.Builder filterBy(FilterExpression filterBy)

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

      Parameters:
      filterBy - The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterBy

      default GetEstimatedWaterAllocationRequest.Builder filterBy(Consumer<FilterExpression.Builder> filterBy)

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

      This is a convenience method that creates an instance of the FilterExpression.Builder avoiding the need to create one manually via FilterExpression.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterBy(FilterExpression).

      Parameters:
      filterBy - a consumer that will call methods on FilterExpression.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allocationTypesWithStrings

      GetEstimatedWaterAllocationRequest.Builder allocationTypesWithStrings(Collection<String> allocationTypes)

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

      Parameters:
      allocationTypes - The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allocationTypesWithStrings

      GetEstimatedWaterAllocationRequest.Builder allocationTypesWithStrings(String... allocationTypes)

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

      Parameters:
      allocationTypes - The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allocationTypes

      GetEstimatedWaterAllocationRequest.Builder allocationTypes(Collection<WaterAllocationType> allocationTypes)

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

      Parameters:
      allocationTypes - The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allocationTypes

      GetEstimatedWaterAllocationRequest.Builder allocationTypes(WaterAllocationType... allocationTypes)

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

      Parameters:
      allocationTypes - The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • granularity

      GetEstimatedWaterAllocationRequest.Builder granularity(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • granularity

      GetEstimatedWaterAllocationRequest.Builder granularity(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      GetEstimatedWaterAllocationRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of results to return in a single call. Default is 1000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetEstimatedWaterAllocationRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetEstimatedWaterAllocationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetEstimatedWaterAllocationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.