Package software.amazon.awssdk.services.networkmonitor.model

Class MonitorSummary

java.lang.Object

software.amazon.awssdk.services.networkmonitor.model.MonitorSummary

All Implemented Interfaces:

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

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

Displays summary information about a monitor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MonitorSummary.Builder

Method Summary

Modifier and Type	Method	Description
Long	aggregationPeriod()	The time, in seconds, that metrics are collected and sent to Amazon CloudWatch.
static MonitorSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	monitorArn()	The ARN of the monitor.
String	monitorName()	The name of the monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends MonitorSummary.Builder>	serializableBuilderClass()
MonitorState	state()	The state of the monitor.
String	stateAsString()	The state of the monitor.
Map<String,String>	tags()	The list of key-value pairs assigned to the monitor.
MonitorSummary.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

monitorArn

public final String monitorArn()

The ARN of the monitor.

Returns:

The ARN of the monitor.

monitorName

public final String monitorName()

The name of the monitor.

Returns:

The name of the monitor.

state

public final MonitorState state()

The state of the monitor.

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

Returns:

The state of the monitor.

See Also:

MonitorState

stateAsString

public final String stateAsString()

The state of the monitor.

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

Returns:

The state of the monitor.

See Also:

MonitorState

aggregationPeriod

public final Long aggregationPeriod()

The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.

Returns:

The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The list of key-value pairs assigned to the monitor.

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

Returns:

The list of key-value pairs assigned to the monitor.

toBuilder

public MonitorSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MonitorSummary.Builder,MonitorSummary>

builder

public static MonitorSummary.Builder builder()

serializableBuilderClass

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