Package software.amazon.awssdk.services.notifications.model

Class NotificationEvent

java.lang.Object

software.amazon.awssdk.services.notifications.model.NotificationEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NotificationEvent.Builder,NotificationEvent>

@Generated("software.amazon.awssdk:codegen")
public final class NotificationEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NotificationEvent.Builder,NotificationEvent>

A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NotificationEvent.Builder

Method Summary

Modifier and Type	Method	Description
String	aggregateNotificationEventArn()	If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.
AggregationEventType	aggregationEventType()	The aggregation type of the NotificationConfiguration.
String	aggregationEventTypeAsString()	The aggregation type of the NotificationConfiguration.
AggregationSummary	aggregationSummary()	Provides additional information about how multiple notifications are grouped.
static NotificationEvent.Builder	builder()
Instant	endTime()	The end time of the event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventStatus	eventStatus()	The assessed nature of the event.
String	eventStatusAsString()	The assessed nature of the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMedia()	For responses, this returns true if the service returned a value for the Media property.
boolean	hasTextParts()	For responses, this returns true if the service returned a value for the TextParts property.
String	id()	The unique identifier for a NotificationEvent.
List<MediaElement>	media()	A list of media elements.
MessageComponents	messageComponents()	Returns the value of the MessageComponents property for this object.
NotificationType	notificationType()	The type of event causing the notification.
String	notificationTypeAsString()	The type of event causing the notification.
SchemaVersion	schemaVersion()	The schema version of the Notification Event.
String	schemaVersionAsString()	The schema version of the Notification Event.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NotificationEvent.Builder>	serializableBuilderClass()
String	sourceEventDetailUrl()	The source event URL.
String	sourceEventDetailUrlDisplayText()	The detailed URL for the source event.
SourceEventMetadata	sourceEventMetadata()	The source event metadata.
Instant	startTime()	The notification event start time.
Map<String,TextPartValue>	textParts()	A list of text values.
NotificationEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

schemaVersion

public final SchemaVersion schemaVersion()

The schema version of the Notification Event.

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:

The schema version of the Notification Event.

See Also:

SchemaVersion

schemaVersionAsString

public final String schemaVersionAsString()

The schema version of the Notification Event.

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:

The schema version of the Notification Event.

See Also:

SchemaVersion

id

public final String id()

The unique identifier for a NotificationEvent.

Returns:

The unique identifier for a NotificationEvent.

sourceEventMetadata

public final SourceEventMetadata sourceEventMetadata()

The source event metadata.

Returns:

The source event metadata.

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()

The source event URL.

Returns:

The source event URL.

sourceEventDetailUrlDisplayText

public final String sourceEventDetailUrlDisplayText()

The detailed URL for the source event.

Returns:

The detailed URL for the source event.

notificationType

public final NotificationType notificationType()

The type of event causing the 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 type of event causing the 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:

NotificationType

notificationTypeAsString

public final String notificationTypeAsString()

The type of event causing the 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 type of event causing the 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:

NotificationType

eventStatus

public final EventStatus eventStatus()

The assessed nature of the 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 assessed nature of the 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:

EventStatus

eventStatusAsString

public final String eventStatusAsString()

The assessed nature of the 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 assessed nature of the 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:

EventStatus

aggregationEventType

public final AggregationEventType aggregationEventType()

The aggregation type of the NotificationConfiguration.

• Values:

  • AGGREGATE

    • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

  • CHILD

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

  • NONE

    • The notification isn't aggregated.

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 aggregation type of the NotificationConfiguration.

• Values:

  • AGGREGATE

    • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

  • CHILD

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

  • NONE

    • The notification isn't aggregated.

See Also:

AggregationEventType

aggregationEventTypeAsString

public final String aggregationEventTypeAsString()

The aggregation type of the NotificationConfiguration.

• Values:

  • AGGREGATE

    • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

  • CHILD

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

  • NONE

    • The notification isn't aggregated.

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 aggregation type of the NotificationConfiguration.

• Values:

  • AGGREGATE

    • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

  • CHILD

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

  • NONE

    • The notification isn't aggregated.

See Also:

AggregationEventType

aggregateNotificationEventArn

public final String aggregateNotificationEventArn()

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

Returns:

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

aggregationSummary

public final AggregationSummary aggregationSummary()

Provides additional information about how multiple notifications are grouped.

Returns:

Provides additional information about how multiple notifications are grouped.

startTime

public final Instant startTime()

The notification event start time.

Returns:

The notification event start time.

endTime

public final Instant endTime()

The end time of the event.

Returns:

The end time of the 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.

hasMedia

public final boolean hasMedia()

For responses, this returns true if the service returned a value for the Media 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.

media

public final List<MediaElement> media()

A list of media elements.

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

Returns:

A list of media elements.

toBuilder

public NotificationEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotificationEvent.Builder,NotificationEvent>

builder

public static NotificationEvent.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo