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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceManagedNotificationEvent.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AggregationEventTypeaggregationEventType()The notifications aggregation type.StringaggregationEventTypeAsString()The notifications aggregation type.AggregationSummaryaggregationSummary()Returns the value of the AggregationSummary property for this object.static ManagedNotificationEvent.Builderbuilder()InstantendTime()The end time of the notification event.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventStatuseventStatus()The status of an event.StringeventStatusAsString()The status of an event.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTextParts()For responses, this returns true if the service returned a value for the TextParts property.Stringid()Unique identifier for aManagedNotificationEvent.MessageComponentsmessageComponents()Returns the value of the MessageComponents property for this object.NotificationTypenotificationType()The nature of the event causing this notification.StringnotificationTypeAsString()The nature of the event causing this notification.StringorganizationalUnitId()The Organizational Unit Id that an Amazon Web Services account belongs to.SchemaVersionschemaVersion()Version of theManagedNotificationEventschema.StringschemaVersionAsString()Version of theManagedNotificationEventschema.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ManagedNotificationEvent.Builder>serializableBuilderClass()StringsourceEventDetailUrl()URL defined by Source Service to be used by notification consumers to get additional information about event.StringsourceEventDetailUrlDisplayText()Text that needs to be hyperlinked with the sourceEventDetailUrl.InstantstartTime()The earliest time of events to return from this call.Map<String,TextPartValue>textParts()A list of text values.ManagedNotificationEvent.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()
Version of the
ManagedNotificationEventschema.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:
- Version of the
ManagedNotificationEventschema. - See Also:
SchemaVersion
-
schemaVersionAsString
public final String schemaVersionAsString()
Version of the
ManagedNotificationEventschema.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:
- Version of the
ManagedNotificationEventschema. - See Also:
SchemaVersion
-
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,
notificationTypewill returnNotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnotificationTypeAsString().- 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:
NotificationType
-
-
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,
notificationTypewill returnNotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnotificationTypeAsString().- 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:
NotificationType
-
-
eventStatus
public final EventStatus eventStatus()
The status of an event.
-
Values:
-
HEALTHY-
All EventRules are
ACTIVEand any call can be run.
-
-
UNHEALTHY-
Some EventRules are
ACTIVEand some areINACTIVE. Any call can be run.
-
-
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:
- The status of an event.
-
Values:
-
HEALTHY-
All EventRules are
ACTIVEand any call can be run.
-
-
UNHEALTHY-
Some EventRules are
ACTIVEand some areINACTIVE. Any call can be run.
-
-
-
- See Also:
EventStatus
-
-
eventStatusAsString
public final String eventStatusAsString()
The status of an event.
-
Values:
-
HEALTHY-
All EventRules are
ACTIVEand any call can be run.
-
-
UNHEALTHY-
Some EventRules are
ACTIVEand some areINACTIVE. Any call can be run.
-
-
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:
- The status of an event.
-
Values:
-
HEALTHY-
All EventRules are
ACTIVEand any call can be run.
-
-
UNHEALTHY-
Some EventRules are
ACTIVEand some areINACTIVE. Any call can be run.
-
-
-
- See Also:
EventStatus
-
-
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,
aggregationEventTypewill returnAggregationEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaggregationEventTypeAsString().- Returns:
- The notifications aggregation type.
- See Also:
AggregationEventType
-
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,
aggregationEventTypewill returnAggregationEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaggregationEventTypeAsString().- Returns:
- The notifications aggregation type.
- See Also:
AggregationEventType
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ManagedNotificationEvent.Builder,ManagedNotificationEvent>
-
builder
public static ManagedNotificationEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends ManagedNotificationEvent.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
-
-