Package 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("software.amazon.awssdk:codegen") public final class CreateTimelineEventRequest extends SsmIncidentsRequest implements ToCopyableBuilder<CreateTimelineEventRequest.Builder,CreateTimelineEventRequest>

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<CreateTimelineEventRequest.Builder,CreateTimelineEventRequest>
      Specified by:
      toBuilder in class SsmIncidentsRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.