com.amazonaws.services.synthetics.model

Class CanaryRun

java.lang.Object

com.amazonaws.services.synthetics.model.CanaryRun

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryRun
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CanaryRun()

Method Summary

Modifier and Type	Method and Description
CanaryRun	clone()
boolean	equals(Object obj)
String	getArtifactS3Location() The location where the canary stored artifacts from the run.
String	getName() The name of the canary.
CanaryRunStatus	getStatus() The status of this run.
CanaryRunTimeline	getTimeline() A structure that contains the start and end times of this run.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setArtifactS3Location(String artifactS3Location) The location where the canary stored artifacts from the run.
void	setName(String name) The name of the canary.
void	setStatus(CanaryRunStatus status) The status of this run.
void	setTimeline(CanaryRunTimeline timeline) A structure that contains the start and end times of this run.
String	toString() Returns a string representation of this object.
CanaryRun	withArtifactS3Location(String artifactS3Location) The location where the canary stored artifacts from the run.
CanaryRun	withName(String name) The name of the canary.
CanaryRun	withStatus(CanaryRunStatus status) The status of this run.
CanaryRun	withTimeline(CanaryRunTimeline timeline) A structure that contains the start and end times of this run.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CanaryRun

public CanaryRun()

Method Detail

setName

public void setName(String name)

The name of the canary.

Parameters:

name - The name of the canary.

getName

public String getName()

The name of the canary.

Returns:

The name of the canary.

withName

public CanaryRun withName(String name)

The name of the canary.

Parameters:

name - The name of the canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(CanaryRunStatus status)

The status of this run.

Parameters:

status - The status of this run.

getStatus

public CanaryRunStatus getStatus()

The status of this run.

Returns:

The status of this run.

withStatus

public CanaryRun withStatus(CanaryRunStatus status)

The status of this run.

Parameters:

status - The status of this run.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimeline

public void setTimeline(CanaryRunTimeline timeline)

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

Parameters:

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

getTimeline

public CanaryRunTimeline getTimeline()

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.

withTimeline

public CanaryRun withTimeline(CanaryRunTimeline timeline)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setArtifactS3Location

public void setArtifactS3Location(String artifactS3Location)

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

Parameters:

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

getArtifactS3Location

public String getArtifactS3Location()

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.

withArtifactS3Location

public CanaryRun withArtifactS3Location(String artifactS3Location)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CanaryRun clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.