Package software.amazon.awssdk.services.ssm.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeAggregator.Builder

Method Summary

Modifier and Type	Method	Description
List<NodeAggregator>	aggregators()	Information about aggregators used to refine a node summary.
NodeAggregatorType	aggregatorType()	The aggregator type for limiting a node summary.
String	aggregatorTypeAsString()	The aggregator type for limiting a node summary.
NodeAttributeName	attributeName()	The name of a node attribute on which to limit the count of nodes.
String	attributeNameAsString()	The name of a node attribute on which to limit the count of nodes.
static NodeAggregator.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregators()	For responses, this returns true if the service returned a value for the Aggregators property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NodeAggregator.Builder>	serializableBuilderClass()
NodeAggregator.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NodeTypeName	typeName()	The data type name to use for viewing counts of nodes.
String	typeNameAsString()	The data type name to use for viewing counts of nodes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

NodeAggregatorType

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:

NodeAggregatorType

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:

NodeTypeName

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:

NodeTypeName

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:

NodeAttributeName

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:

NodeAttributeName

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()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeAggregator.Builder,NodeAggregator>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo