Class ManagedNotificationEvent

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

A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.

See Also:

  • Method Details

    • schemaVersion

      public final SchemaVersion schemaVersion()

      Version of the ManagedNotificationEvent schema.

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

      Returns:
      Version of the ManagedNotificationEvent schema.
      See Also:

    • schemaVersionAsString

      public final String schemaVersionAsString()

      Version of the ManagedNotificationEvent schema.

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

      Returns:
      Version of the ManagedNotificationEvent schema.
      See Also:

    • id

      public final String id()

      Unique identifier for a ManagedNotificationEvent.

      Returns:
      Unique identifier for a ManagedNotificationEvent.

    • messageComponents

      public final MessageComponents messageComponents()
      Returns the value of the MessageComponents property for this object.
      Returns:
      The value of the MessageComponents property for this object.

    • sourceEventDetailUrl

      public final String sourceEventDetailUrl()

      URL defined by Source Service to be used by notification consumers to get additional information about event.

      Returns:
      URL defined by Source Service to be used by notification consumers to get additional information about event.

    • sourceEventDetailUrlDisplayText

      public final String sourceEventDetailUrlDisplayText()

      Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.

      Returns:
      Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.

    • notificationType

      public final NotificationType notificationType()

      The nature of the event causing this notification.

      • Values:

        • ALERT

          • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        • WARNING

          • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        • ANNOUNCEMENT

          • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        • INFORMATIONAL

          • A notification about informational messages. For example, recommendations, service announcements, or reminders.

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

      Returns:
      The nature of the event causing this notification.

      • Values:

        • ALERT

          • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        • WARNING

          • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        • ANNOUNCEMENT

          • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        • INFORMATIONAL

          • A notification about informational messages. For example, recommendations, service announcements, or reminders.

      See Also:

    • notificationTypeAsString

      public final String notificationTypeAsString()

      The nature of the event causing this notification.

      • Values:

        • ALERT

          • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        • WARNING

          • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        • ANNOUNCEMENT

          • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        • INFORMATIONAL

          • A notification about informational messages. For example, recommendations, service announcements, or reminders.

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

      Returns:
      The nature of the event causing this notification.

      • Values:

        • ALERT

          • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        • WARNING

          • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        • ANNOUNCEMENT

          • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        • INFORMATIONAL

          • A notification about informational messages. For example, recommendations, service announcements, or reminders.

      See Also:

    • eventStatus

      public final EventStatus eventStatus()

      The status of an event.

      • Values:

        • HEALTHY

          • All EventRules are ACTIVE and any call can be run.

        • UNHEALTHY

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

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

      Returns:
      The status of an event.

      • Values:

        • HEALTHY

          • All EventRules are ACTIVE and any call can be run.

        • UNHEALTHY

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

      See Also:

    • eventStatusAsString

      public final String eventStatusAsString()

      The status of an event.

      • Values:

        • HEALTHY

          • All EventRules are ACTIVE and any call can be run.

        • UNHEALTHY

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

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

      Returns:
      The status of an event.

      • Values:

        • HEALTHY

          • All EventRules are ACTIVE and any call can be run.

        • UNHEALTHY

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

      See Also:

    • aggregationEventType

      public final AggregationEventType aggregationEventType()

      The notifications aggregation type.

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

      Returns:
      The notifications aggregation type.
      See Also:

    • aggregationEventTypeAsString

      public final String aggregationEventTypeAsString()

      The notifications aggregation type.

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

      Returns:
      The notifications aggregation type.
      See Also:

    • aggregationSummary

      public final AggregationSummary aggregationSummary()
      Returns the value of the AggregationSummary property for this object.
      Returns:
      The value of the AggregationSummary property for this object.

    • startTime

      public final Instant startTime()

      The earliest time of events to return from this call.

      Returns:
      The earliest time of events to return from this call.

    • endTime

      public final Instant endTime()

      The end time of the notification event.

      Returns:
      The end time of the notification event.

    • hasTextParts

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

    • textParts

      public final Map<String,TextPartValue> textParts()

      A list of text values.

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

      Returns:
      A list of text values.

    • organizationalUnitId

      public final String organizationalUnitId()

      The Organizational Unit Id that an Amazon Web Services account belongs to.

      Returns:
      The Organizational Unit Id that an Amazon Web Services account belongs to.

    • toBuilder

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

    • builder

      public static ManagedNotificationEvent.Builder builder()

    • serializableBuilderClass

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