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

Class AlarmContributor

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.AlarmContributor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlarmContributor.Builder,AlarmContributor>

@Generated("software.amazon.awssdk:codegen")
public final class AlarmContributor
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlarmContributor.Builder,AlarmContributor>

Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlarmContributor.Builder

Method Summary

Modifier and Type	Method	Description
static AlarmContributor.Builder	builder()
Map<String,String>	contributorAttributes()	A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.
String	contributorId()	The unique identifier for this alarm contributor.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContributorAttributes()	For responses, this returns true if the service returned a value for the ContributorAttributes property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AlarmContributor.Builder>	serializableBuilderClass()
String	stateReason()	An explanation for the contributor's current state, providing context about why it is in its current condition.
Instant	stateTransitionedTimestamp()	The timestamp when the contributor last transitioned to its current state.
AlarmContributor.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

contributorId

public final String contributorId()

The unique identifier for this alarm contributor.

Returns:

The unique identifier for this alarm contributor.

hasContributorAttributes

public final boolean hasContributorAttributes()

For responses, this returns true if the service returned a value for the ContributorAttributes 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.

contributorAttributes

public final Map<String,String> contributorAttributes()

A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.

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

Returns:

A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.

stateReason

public final String stateReason()

An explanation for the contributor's current state, providing context about why it is in its current condition.

Returns:

An explanation for the contributor's current state, providing context about why it is in its current condition.

stateTransitionedTimestamp

public final Instant stateTransitionedTimestamp()

The timestamp when the contributor last transitioned to its current state.

Returns:

The timestamp when the contributor last transitioned to its current state.

toBuilder

public AlarmContributor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlarmContributor.Builder,AlarmContributor>

builder

public static AlarmContributor.Builder builder()

serializableBuilderClass

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