Package software.amazon.awssdk.services.ssmsap.model

Class OperationEvent

java.lang.Object

software.amazon.awssdk.services.ssmsap.model.OperationEvent

All Implemented Interfaces:

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

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OperationEvent.Builder

Method Summary

Modifier and Type	Method	Description
static OperationEvent.Builder	builder()
String	description()	A description of the operation event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Resource	resource()	The resource involved in the operations event.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OperationEvent.Builder>	serializableBuilderClass()
OperationEventStatus	status()	The status of the operation event.
String	statusAsString()	The status of the operation event.
String	statusMessage()	The status message relating to a specific operation event.
Instant	timestamp()	The timestamp of the specified operation event.
OperationEvent.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

description

public final String description()

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

resource

public final Resource resource()

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.

status

public final OperationEventStatus status()

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

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

Returns:

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

See Also:

OperationEventStatus

statusAsString

public final String statusAsString()

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

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

Returns:

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

See Also:

OperationEventStatus

statusMessage

public final String statusMessage()

The status message relating to a specific operation event.

Returns:

The status message relating to a specific operation event.

timestamp

public final Instant timestamp()

The timestamp of the specified operation event.

Returns:

The timestamp of the specified operation event.

toBuilder

public OperationEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OperationEvent.Builder,OperationEvent>

builder

public static OperationEvent.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo