software.amazon.awssdk.services.ssmincidents.model

Class CreateTimelineEventRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmincidents.model.SsmIncidentsRequest

software.amazon.awssdk.services.ssmincidents.model.CreateTimelineEventRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTimelineEventRequest.Builder,CreateTimelineEventRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTimelineEventRequest
extends SsmIncidentsRequest
implements ToCopyableBuilder<CreateTimelineEventRequest.Builder,CreateTimelineEventRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTimelineEventRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTimelineEventRequest.Builder	builder()
String	clientToken() A token that ensures that a client calls the action only once with the specified details.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventData() A short description of the event.
List<EventReference>	eventReferences() Adds one or more references to the TimelineEvent.
Instant	eventTime() The time that the event occurred.
String	eventType() The type of event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventReferences() For responses, this returns true if the service returned a value for the EventReferences property.
int	hashCode()
String	incidentRecordArn() The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTimelineEventRequest.Builder>	serializableBuilderClass()
CreateTimelineEventRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

A token that ensures that a client calls the action only once with the specified details.

Returns:

A token that ensures that a client calls the action only once with the specified details.

eventData

public final String eventData()

A short description of the event.

Returns:

A short description of the event.

hasEventReferences

public final boolean hasEventReferences()

For responses, this returns true if the service returned a value for the EventReferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

eventReferences

public final List<EventReference> eventReferences()

Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEventReferences() method.

Returns:

Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

eventTime

public final Instant eventTime()

The time that the event occurred.

Returns:

The time that the event occurred.

eventType

public final String eventType()

The type of event. You can create timeline events of type Custom Event.

Returns:

The type of event. You can create timeline events of type Custom Event.

incidentRecordArn

public final String incidentRecordArn()

The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.

Returns:

The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.

toBuilder

public CreateTimelineEventRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTimelineEventRequest.Builder,CreateTimelineEventRequest>

Specified by:

toBuilder in class SsmIncidentsRequest

builder

public static CreateTimelineEventRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTimelineEventRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo