com.amazonaws.services.ssmsap.model

Class OperationEvent

java.lang.Object

com.amazonaws.services.ssmsap.model.OperationEvent

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.

Operation events contain:

• Description string

• Resource, including its ARN and type

• Status

• StatusMessage string

• TimeStamp

Operation event examples include StartApplication or StopApplication.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OperationEvent()

Method Summary

Modifier and Type	Method and Description
OperationEvent	clone()
boolean	equals(Object obj)
String	getDescription() A description of the operation event.
Resource	getResource() The resource involved in the operations event.
String	getStatus() The status of the operation event.
String	getStatusMessage() The status message relating to a specific operation event.
Date	getTimestamp() The timestamp of the specified operation event.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDescription(String description) A description of the operation event.
void	setResource(Resource resource) The resource involved in the operations event.
void	setStatus(String status) The status of the operation event.
void	setStatusMessage(String statusMessage) The status message relating to a specific operation event.
void	setTimestamp(Date timestamp) The timestamp of the specified operation event.
String	toString() Returns a string representation of this object.
OperationEvent	withDescription(String description) A description of the operation event.
OperationEvent	withResource(Resource resource) The resource involved in the operations event.
OperationEvent	withStatus(OperationEventStatus status) The status of the operation event.
OperationEvent	withStatus(String status) The status of the operation event.
OperationEvent	withStatusMessage(String statusMessage) The status message relating to a specific operation event.
OperationEvent	withTimestamp(Date timestamp) The timestamp of the specified operation event.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OperationEvent

public OperationEvent()

Method Detail

setDescription

public void setDescription(String description)

A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

Parameters:

description - A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

getDescription

public String getDescription()

A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

Returns:

A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

withDescription

public OperationEvent withDescription(String description)

A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

Parameters:

description - A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

Returns:

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

setResource

public void setResource(Resource resource)

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

Parameters:

resource - The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

getResource

public Resource getResource()

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

Returns:

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

withResource

public OperationEvent withResource(Resource resource)

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

Parameters:

resource - The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

Returns:

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

setStatus

public void setStatus(String status)

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Parameters:

status - The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

See Also:

OperationEventStatus

getStatus

public String getStatus()

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Returns:

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

See Also:

OperationEventStatus

withStatus

public OperationEvent withStatus(String status)

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Parameters:

status - The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Returns:

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

See Also:

OperationEventStatus

withStatus

public OperationEvent withStatus(OperationEventStatus status)

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Parameters:

status - The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

Returns:

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

See Also:

OperationEventStatus

setStatusMessage

public void setStatusMessage(String statusMessage)

The status message relating to a specific operation event.

Parameters:

statusMessage - The status message relating to a specific operation event.

getStatusMessage

public String getStatusMessage()

The status message relating to a specific operation event.

Returns:

The status message relating to a specific operation event.

withStatusMessage

public OperationEvent withStatusMessage(String statusMessage)

The status message relating to a specific operation event.

Parameters:

statusMessage - The status message relating to a specific operation event.

Returns:

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

setTimestamp

public void setTimestamp(Date timestamp)

The timestamp of the specified operation event.

Parameters:

timestamp - The timestamp of the specified operation event.

getTimestamp

public Date getTimestamp()

The timestamp of the specified operation event.

Returns:

The timestamp of the specified operation event.

withTimestamp

public OperationEvent withTimestamp(Date timestamp)

The timestamp of the specified operation event.

Parameters:

timestamp - The timestamp of the specified operation event.

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 OperationEvent 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.