Class QueryParameters

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

Defines the data retrieval parameters for a widget.

See Also:

  • Method Details

    • costAndUsage

      public final CostAndUsageQuery costAndUsage()

      The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

      Returns:
      The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

    • savingsPlansCoverage

      public final SavingsPlansCoverageQuery savingsPlansCoverage()

      The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

      Returns:
      The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

    • savingsPlansUtilization

      public final SavingsPlansUtilizationQuery savingsPlansUtilization()

      The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

      Returns:
      The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

    • reservationCoverage

      public final ReservationCoverageQuery reservationCoverage()

      The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

      Returns:
      The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

    • reservationUtilization

      public final ReservationUtilizationQuery reservationUtilization()

      The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

      Returns:
      The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

    • toBuilder

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

    • builder

      public static QueryParameters.Builder builder()

    • serializableBuilderClass

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

    • fromCostAndUsage

      public static QueryParameters fromCostAndUsage(CostAndUsageQuery costAndUsage)
      Create an instance of this class with costAndUsage() initialized to the given value.

      The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

      Parameters:
      costAndUsage - The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

    • fromCostAndUsage

      public static QueryParameters fromCostAndUsage(Consumer<CostAndUsageQuery.Builder> costAndUsage)
      Create an instance of this class with costAndUsage() initialized to the given value.

      The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

      Parameters:
      costAndUsage - The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

    • fromSavingsPlansCoverage

      public static QueryParameters fromSavingsPlansCoverage(SavingsPlansCoverageQuery savingsPlansCoverage)
      Create an instance of this class with savingsPlansCoverage() initialized to the given value.

      The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

      Parameters:
      savingsPlansCoverage - The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

    • fromSavingsPlansCoverage

      public static QueryParameters fromSavingsPlansCoverage(Consumer<SavingsPlansCoverageQuery.Builder> savingsPlansCoverage)
      Create an instance of this class with savingsPlansCoverage() initialized to the given value.

      The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

      Parameters:
      savingsPlansCoverage - The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

    • fromSavingsPlansUtilization

      public static QueryParameters fromSavingsPlansUtilization(SavingsPlansUtilizationQuery savingsPlansUtilization)
      Create an instance of this class with savingsPlansUtilization() initialized to the given value.

      The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

      Parameters:
      savingsPlansUtilization - The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

    • fromSavingsPlansUtilization

      public static QueryParameters fromSavingsPlansUtilization(Consumer<SavingsPlansUtilizationQuery.Builder> savingsPlansUtilization)
      Create an instance of this class with savingsPlansUtilization() initialized to the given value.

      The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

      Parameters:
      savingsPlansUtilization - The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

    • fromReservationCoverage

      public static QueryParameters fromReservationCoverage(ReservationCoverageQuery reservationCoverage)
      Create an instance of this class with reservationCoverage() initialized to the given value.

      The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

      Parameters:
      reservationCoverage - The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

    • fromReservationCoverage

      public static QueryParameters fromReservationCoverage(Consumer<ReservationCoverageQuery.Builder> reservationCoverage)
      Create an instance of this class with reservationCoverage() initialized to the given value.

      The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

      Parameters:
      reservationCoverage - The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

    • fromReservationUtilization

      public static QueryParameters fromReservationUtilization(ReservationUtilizationQuery reservationUtilization)
      Create an instance of this class with reservationUtilization() initialized to the given value.

      The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

      Parameters:
      reservationUtilization - The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

    • fromReservationUtilization

      public static QueryParameters fromReservationUtilization(Consumer<ReservationUtilizationQuery.Builder> reservationUtilization)
      Create an instance of this class with reservationUtilization() initialized to the given value.

      The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

      Parameters:
      reservationUtilization - The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

    • type

      public QueryParameters.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be QueryParameters.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be QueryParameters.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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