Package software.amazon.awssdk.services.cloudwatch.model

Class GetInsightRuleReportRequest

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

  • Method Details

    • ruleName

      public final String ruleName()

      The name of the rule that you want to see data from.

      Returns:
      The name of the rule that you want to see data from.

    • startTime

      public final Instant startTime()

      The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      Returns:
      The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

    • endTime

      public final Instant endTime()

      The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      Returns:
      The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

    • period

      public final Integer period()

      The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

      Returns:
      The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

    • maxContributorCount

      public final Integer maxContributorCount()

      The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

      Returns:
      The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

    • hasMetrics

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

    • metrics

      public final List<String> metrics()

      Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

      • UniqueContributors -- the number of unique contributors for each data point.

      • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

        If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

      • SampleCount -- the number of data points matched by the rule.

      • Sum -- the sum of the values from all contributors during the time period represented by that data point.

      • Minimum -- the minimum value from a single observation during the time period represented by that data point.

      • Maximum -- the maximum value from a single observation during the time period represented by that data point.

      • Average -- the average value from all contributors during the time period represented by that data point.

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

      Returns:
      Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

      • UniqueContributors -- the number of unique contributors for each data point.

      • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

        If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

      • SampleCount -- the number of data points matched by the rule.

      • Sum -- the sum of the values from all contributors during the time period represented by that data point.

      • Minimum -- the minimum value from a single observation during the time period represented by that data point.

      • Maximum -- the maximum value from a single observation during the time period represented by that data point.

      • Average -- the average value from all contributors during the time period represented by that data point.

    • orderBy

      public final String orderBy()

      Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.

      Returns:
      Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.

    • toBuilder

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

    • builder

      public static GetInsightRuleReportRequest.Builder builder()

    • serializableBuilderClass

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