Class UpdateTimelineEventRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateTimelineEventRequest.Builder,
UpdateTimelineEventRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A token that ensures that a client calls the operation only once with the specified details.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A short description of the event.final String
eventId()
The ID of the event to update.final List
<EventReference> Updates all existing references in aTimelineEvent
.final Instant
The timestamp for when the event occurred.final String
The type of event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EventReferences property.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the incident that includes the timeline event.static Class
<? extends UpdateTimelineEventRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientToken
A token that ensures that a client calls the operation only once with the specified details.
- Returns:
- A token that ensures that a client calls the operation only once with the specified details.
-
eventData
A short description of the event.
- Returns:
- A short description of the event.
-
eventId
The ID of the event to update. You can use
ListTimelineEvents
to find an event's ID.- Returns:
- The ID of the event to update. You can use
ListTimelineEvents
to find an event's ID.
-
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 theisEmpty()
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
Updates all existing references in a
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 that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.
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:
- Updates all existing references in a
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 that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.
-
eventTime
The timestamp for when the event occurred.
- Returns:
- The timestamp for when the event occurred.
-
eventType
The type of event. You can update events of type
Custom Event
andNote
.- Returns:
- The type of event. You can update events of type
Custom Event
andNote
.
-
incidentRecordArn
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
- Returns:
- The Amazon Resource Name (ARN) of the incident that includes the timeline event.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateTimelineEventRequest.Builder,
UpdateTimelineEventRequest> - Specified by:
toBuilder
in classSsmIncidentsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-