Class SourceEventMetadata

java.lang.Object
software.amazon.awssdk.services.notifications.model.SourceEventMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SourceEventMetadata.Builder,SourceEventMetadata>
@Generated("software.amazon.awssdk:codegen") public final class SourceEventMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SourceEventMetadata.Builder,SourceEventMetadata>

Describes the metadata for a source event.

For more information, see Event structure reference in the Amazon EventBridge User Guide.

See Also:

  • Method Details

    • eventTypeVersion

      public final String eventTypeVersion()

      The version of the type of event.

      Returns:
      The version of the type of event.

    • sourceEventId

      public final String sourceEventId()

      The source event id.

      Returns:
      The source event id.

    • eventOriginRegion

      public final String eventOriginRegion()

      The Region the event originated from.

      Returns:
      The Region the event originated from.

    • relatedAccount

      public final String relatedAccount()

      The primary Amazon Web Services account of SourceEvent.

      Returns:
      The primary Amazon Web Services account of SourceEvent.

    • source

      public final String source()

      The Amazon Web Services service the event originates from. For example aws.cloudwatch.

      Returns:
      The Amazon Web Services service the event originates from. For example aws.cloudwatch.

    • eventOccurrenceTime

      public final Instant eventOccurrenceTime()

      The date and time the source event occurred. This is based on the Source Event.

      Returns:
      The date and time the source event occurred. This is based on the Source Event.

    • eventType

      public final String eventType()

      The type of event. For example, an Amazon CloudWatch state change.

      Returns:
      The type of event. For example, an Amazon CloudWatch state change.

    • hasRelatedResources

      public final boolean hasRelatedResources()
      For responses, this returns true if the service returned a value for the RelatedResources 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.

    • relatedResources

      public final List<Resource> relatedResources()

      A list of resources related to this NotificationEvent.

      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 hasRelatedResources() method.

      Returns:
      A list of resources related to this NotificationEvent.

    • toBuilder

      public SourceEventMetadata.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<SourceEventMetadata.Builder,SourceEventMetadata>
      Returns:
      a builder for type T

    • builder

      public static SourceEventMetadata.Builder builder()

    • serializableBuilderClass

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.