Package software.amazon.awssdk.services.forecast.model

Class MonitorSummary

java.lang.Object

software.amazon.awssdk.services.forecast.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>

Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties, call the DescribeMonitor operation, and provide the listed MonitorArn.

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
static MonitorSummary.Builder	builder()
Instant	creationTime()	When the monitor resource was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime()	The last time the monitor resource was modified.
String	monitorArn()	The Amazon Resource Name (ARN) of the monitor resource.
String	monitorName()	The name of the monitor resource.
String	resourceArn()	The Amazon Resource Name (ARN) of the predictor being monitored.
List<SdkField<?>>	sdkFields()
static Class<? extends MonitorSummary.Builder>	serializableBuilderClass()
String	status()	The status of 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 Amazon Resource Name (ARN) of the monitor resource.

Returns:

The Amazon Resource Name (ARN) of the monitor resource.

monitorName

public final String monitorName()

The name of the monitor resource.

Returns:

The name of the monitor resource.

resourceArn

public final String resourceArn()

The Amazon Resource Name (ARN) of the predictor being monitored.

Returns:

The Amazon Resource Name (ARN) of the predictor being monitored.

status

public final String status()

The status of the monitor. States include:

• ACTIVE

• ACTIVE_STOPPING, ACTIVE_STOPPED

• UPDATE_IN_PROGRESS

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

The status of the monitor. States include:

• ACTIVE

• ACTIVE_STOPPING, ACTIVE_STOPPED

• UPDATE_IN_PROGRESS

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

creationTime

public final Instant creationTime()

When the monitor resource was created.

Returns:

When the monitor resource was created.

lastModificationTime

public final Instant lastModificationTime()

The last time the monitor resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• STOPPED - When the resource stopped.

• ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.

Returns:

The last time the monitor resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• STOPPED - When the resource stopped.

• ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.

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