Class NodeAggregator

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

One or more aggregators for viewing counts of nodes using different dimensions.

See Also:

  • Method Details

    • aggregatorType

      public final NodeAggregatorType aggregatorType()

      The aggregator type for limiting a node summary. Currently, only Count is supported.

      If the service returns an enum value that is not available in the current SDK version, aggregatorType will return NodeAggregatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregatorTypeAsString().

      Returns:
      The aggregator type for limiting a node summary. Currently, only Count is supported.
      See Also:

    • aggregatorTypeAsString

      public final String aggregatorTypeAsString()

      The aggregator type for limiting a node summary. Currently, only Count is supported.

      If the service returns an enum value that is not available in the current SDK version, aggregatorType will return NodeAggregatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregatorTypeAsString().

      Returns:
      The aggregator type for limiting a node summary. Currently, only Count is supported.
      See Also:

    • typeName

      public final NodeTypeName typeName()

      The data type name to use for viewing counts of nodes. Currently, only Instance is supported.

      If the service returns an enum value that is not available in the current SDK version, typeName will return NodeTypeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeNameAsString().

      Returns:
      The data type name to use for viewing counts of nodes. Currently, only Instance is supported.
      See Also:

    • typeNameAsString

      public final String typeNameAsString()

      The data type name to use for viewing counts of nodes. Currently, only Instance is supported.

      If the service returns an enum value that is not available in the current SDK version, typeName will return NodeTypeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeNameAsString().

      Returns:
      The data type name to use for viewing counts of nodes. Currently, only Instance is supported.
      See Also:

    • attributeName

      public final NodeAttributeName attributeName()

      The name of a node attribute on which to limit the count of nodes.

      If the service returns an enum value that is not available in the current SDK version, attributeName will return NodeAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeNameAsString().

      Returns:
      The name of a node attribute on which to limit the count of nodes.
      See Also:

    • attributeNameAsString

      public final String attributeNameAsString()

      The name of a node attribute on which to limit the count of nodes.

      If the service returns an enum value that is not available in the current SDK version, attributeName will return NodeAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeNameAsString().

      Returns:
      The name of a node attribute on which to limit the count of nodes.
      See Also:

    • 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<NodeAggregator> aggregators()

      Information about aggregators used to refine a node summary.

      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:
      Information about aggregators used to refine a node summary.

    • toBuilder

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

    • builder

      public static NodeAggregator.Builder builder()

    • serializableBuilderClass

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