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

Class NotificationEventSummary

java.lang.Object

software.amazon.awssdk.services.notifications.model.NotificationEventSummary

All Implemented Interfaces:

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

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

Describes a short summary and metadata for a notification event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NotificationEventSummary.Builder

Method Summary

Modifier and Type	Method	Description
static NotificationEventSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventStatus	eventStatus()	The notification event status.
String	eventStatusAsString()	The notification event status.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageComponentsSummary	messageComponents()	The message components of a notification event.
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 NotificationEventSummary.Builder>	serializableBuilderClass()
SourceEventMetadataSummary	sourceEventMetadata()	The source event metadata.
NotificationEventSummary.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

sourceEventMetadata

public final SourceEventMetadataSummary sourceEventMetadata()

The source event metadata.

Returns:

The source event metadata.

messageComponents

public final MessageComponentsSummary messageComponents()

The message components of a notification event.

Returns:

The message components of a notification event.

eventStatus

public final EventStatus eventStatus()

The notification event status.

• 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 notification event status.

• 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 notification event status.

• 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 notification event status.

• 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

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

toBuilder

public NotificationEventSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotificationEventSummary.Builder,NotificationEventSummary>

builder

public static NotificationEventSummary.Builder builder()

serializableBuilderClass

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