Class OpsAggregator

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

One or more aggregators for viewing counts of OpsData using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.

See Also:

  • Method Details

    • aggregatorType

      public final String aggregatorType()

      Either a Range or Count aggregator for limiting an OpsData summary.

      Returns:
      Either a Range or Count aggregator for limiting an OpsData summary.

    • typeName

      public final String typeName()

      The data type name to use for viewing counts of OpsData.

      Returns:
      The data type name to use for viewing counts of OpsData.

    • attributeName

      public final String attributeName()

      The name of an OpsData attribute on which to limit the count of OpsData.

      Returns:
      The name of an OpsData attribute on which to limit the count of OpsData.

    • hasValues

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

    • values

      public final Map<String,String> values()

      The aggregator value.

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

      Returns:
      The aggregator value.

    • hasFilters

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

    • filters

      public final List<OpsFilter> filters()

      The aggregator filters.

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

      Returns:
      The aggregator filters.

    • hasAggregators

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

    • aggregators

      public final List<OpsAggregator> aggregators()

      A nested aggregator for viewing counts of OpsData.

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

      Returns:
      A nested aggregator for viewing counts of OpsData.

    • toBuilder

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

    • builder

      public static OpsAggregator.Builder builder()

    • serializableBuilderClass

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