Class GetCapacityManagerMetricDimensionsRequest

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

  • Method Details

    • groupBy

      public final List<GroupBy> groupBy()

      The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

      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 to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

    • 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 to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

      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 to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

    • hasFilterBy

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

    • filterBy

      public final List<CapacityManagerCondition> filterBy()

      Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

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

      Returns:
      Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

    • startTime

      public final Instant startTime()

      The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

      Returns:
      The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

    • endTime

      public final Instant endTime()

      The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

      Returns:
      The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

    • metricNames

      public final List<Metric> metricNames()

      The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

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

      Returns:
      The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

    • hasMetricNames

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

    • metricNamesAsStrings

      public final List<String> metricNamesAsStrings()

      The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

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

      Returns:
      The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

    • maxResults

      public final Integer maxResults()

      The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

      Returns:
      The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

    • nextToken

      public final String nextToken()

      The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

      Returns:
      The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • toBuilder

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

    • builder

      public static GetCapacityManagerMetricDimensionsRequest.Builder builder()

    • serializableBuilderClass

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