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 interfaceNotificationEventSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NotificationEventSummary.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventStatuseventStatus()Provides additional information about the current status of theNotificationEvent.StringeventStatusAsString()Provides additional information about the current status of theNotificationEvent.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()MessageComponentsSummarymessageComponents()The message components of a notification event.NotificationTypenotificationType()The type of event causing the notification.StringnotificationTypeAsString()The type of event causing the notification.SchemaVersionschemaVersion()The schema version of the Notification Event.StringschemaVersionAsString()The schema version of the Notification Event.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends NotificationEventSummary.Builder>serializableBuilderClass()SourceEventMetadataSummarysourceEventMetadata()The source event metadata.NotificationEventSummary.BuildertoBuilder()StringtoString()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,
schemaVersionwill returnSchemaVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromschemaVersionAsString().- 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,
schemaVersionwill returnSchemaVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromschemaVersionAsString().- 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
EventRulesareACTIVE.
-
-
UNHEALTHY-
Some
EventRulesareACTIVEand some areINACTIVE.
-
-
If the service returns an enum value that is not available in the current SDK version,
eventStatuswill returnEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventStatusAsString().- Returns:
- Provides additional information about the current status of the
NotificationEvent.-
Values:
-
HEALTHY-
All
EventRulesareACTIVE.
-
-
UNHEALTHY-
Some
EventRulesareACTIVEand some areINACTIVE.
-
-
-
- See Also:
EventStatus
-
-
eventStatusAsString
public final String eventStatusAsString()
Provides additional information about the current status of the
NotificationEvent.-
Values:
-
HEALTHY-
All
EventRulesareACTIVE.
-
-
UNHEALTHY-
Some
EventRulesareACTIVEand some areINACTIVE.
-
-
If the service returns an enum value that is not available in the current SDK version,
eventStatuswill returnEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventStatusAsString().- Returns:
- Provides additional information about the current status of the
NotificationEvent.-
Values:
-
HEALTHY-
All
EventRulesareACTIVE.
-
-
UNHEALTHY-
Some
EventRulesareACTIVEand some areINACTIVE.
-
-
-
- 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,
notificationTypewill returnNotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnotificationTypeAsString().- 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,
notificationTypewill returnNotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnotificationTypeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<NotificationEventSummary.Builder,NotificationEventSummary>
-
builder
public static NotificationEventSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends NotificationEventSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-