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

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()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final EventStatus	eventStatus()	Provides additional information about the current status of the NotificationEvent.
final String	eventStatusAsString()	Provides additional information about the current status of the NotificationEvent.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final MessageComponentsSummary	messageComponents()	The message components of a notification event.
final NotificationType	notificationType()	The type of event causing the notification.
final String	notificationTypeAsString()	The type of event causing the notification.
final SchemaVersion	schemaVersion()	The schema version of the Notification Event.
final String	schemaVersionAsString()	The schema version of the Notification Event.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends NotificationEventSummary.Builder>	serializableBuilderClass()
final SourceEventMetadataSummary	sourceEventMetadata()	The source event metadata.
NotificationEventSummary.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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

Provides additional information about the current status of the NotificationEvent.

• Values:

  • HEALTHY

    • All EventRules are ACTIVE.

  • UNHEALTHY

    • Some EventRules are ACTIVE and some are INACTIVE.

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:

Provides additional information about the current status of the NotificationEvent.

• Values:

  • HEALTHY

    • All EventRules are ACTIVE.

  • UNHEALTHY

    • Some EventRules are ACTIVE and some are INACTIVE.

See Also:

• EventStatus

eventStatusAsString

public final String eventStatusAsString()

Provides additional information about the current status of the NotificationEvent.

• Values:

  • HEALTHY

    • All EventRules are ACTIVE.

  • UNHEALTHY

    • Some EventRules are ACTIVE and some are INACTIVE.

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:

Provides additional information about the current status of the NotificationEvent.

• Values:

  • HEALTHY

    • All EventRules are ACTIVE.

  • UNHEALTHY

    • Some EventRules are ACTIVE and some are INACTIVE.

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

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<NotificationEventSummary.Builder,NotificationEventSummary>

Returns:

a builder for type T

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)

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.