Package software.amazon.awssdk.services.synthetics.model

Class CanaryRun

java.lang.Object

software.amazon.awssdk.services.synthetics.model.CanaryRun

All Implemented Interfaces:

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

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

This structure contains the details about one run of one canary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryRun.Builder

Method Summary

Modifier and Type	Method	Description
String	artifactS3Location()	The location where the canary stored artifacts from the run.
static CanaryRun.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A unique ID that identifies this canary run.
String	name()	The name of the canary.
List<SdkField<?>>	sdkFields()
static Class<? extends CanaryRun.Builder>	serializableBuilderClass()
CanaryRunStatus	status()	The status of this run.
CanaryRunTimeline	timeline()	A structure that contains the start and end times of this run.
CanaryRun.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

id

public final String id()

A unique ID that identifies this canary run.

Returns:

A unique ID that identifies this canary run.

name

public final String name()

The name of the canary.

Returns:

The name of the canary.

status

public final CanaryRunStatus status()

The status of this run.

Returns:

The status of this run.

timeline

public final CanaryRunTimeline timeline()

A structure that contains the start and end times of this run.

Returns:

A structure that contains the start and end times of this run.

artifactS3Location

public final String artifactS3Location()

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

Returns:

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

toBuilder

public CanaryRun.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryRun.Builder,CanaryRun>

builder

public static CanaryRun.Builder builder()

serializableBuilderClass

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