Class InsightRuleContributor

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

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport.

See Also:

  • Method Details

    • hasKeys

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

    • keys

      public final List<String> keys()

      One of the log entry field keywords that is used to define contributors for this rule.

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

      Returns:
      One of the log entry field keywords that is used to define contributors for this rule.

    • approximateAggregateValue

      public final Double approximateAggregateValue()

      An approximation of the aggregate value that comes from this contributor.

      Returns:
      An approximation of the aggregate value that comes from this contributor.

    • hasDatapoints

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

    • datapoints

      public final List<InsightRuleContributorDatapoint> datapoints()

      An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.

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

      Returns:
      An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.

    • toBuilder

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

    • builder

      public static InsightRuleContributor.Builder builder()

    • serializableBuilderClass

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

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