Class GetInsightRuleReportResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInsightRuleReportResponse.Builder,GetInsightRuleReportResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetInsightRuleReportResponse extends CloudWatchResponse implements ToCopyableBuilder<GetInsightRuleReportResponse.Builder,GetInsightRuleReportResponse>

  • Method Details

    • hasKeyLabels

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

    • keyLabels

      public final List<String> keyLabels()

      An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

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

      Returns:
      An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

    • aggregationStatistic

      public final String aggregationStatistic()

      Specifies whether this rule aggregates contributor data by COUNT or SUM.

      Returns:
      Specifies whether this rule aggregates contributor data by COUNT or SUM.

    • aggregateValue

      public final Double aggregateValue()

      The sum of the values from all individual contributors that match the rule.

      Returns:
      The sum of the values from all individual contributors that match the rule.

    • approximateUniqueCount

      public final Long approximateUniqueCount()

      An approximate count of the unique contributors found by this rule in this time period.

      Returns:
      An approximate count of the unique contributors found by this rule in this time period.

    • hasContributors

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

    • contributors

      public final List<InsightRuleContributor> contributors()

      An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.

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

      Returns:
      An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.

    • hasMetricDatapoints

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

    • metricDatapoints

      public final List<InsightRuleMetricDatapoint> metricDatapoints()

      A time series of metric data points that matches the time period in the rule request.

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

      Returns:
      A time series of metric data points that matches the time period in the rule request.

    • toBuilder

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

    • builder

      public static GetInsightRuleReportResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.