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

Interface NotificationEvent.Builder

    • Method Detail

      • schemaVersion

        NotificationEvent.Builder schemaVersion​(String schemaVersion)

        The schema version of the Notification Event.

        Parameters:
        schemaVersion - The schema version of the Notification Event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SchemaVersion, SchemaVersion

      • schemaVersion

        NotificationEvent.Builder schemaVersion​(SchemaVersion schemaVersion)

        The schema version of the Notification Event.

        Parameters:
        schemaVersion - The schema version of the Notification Event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SchemaVersion, SchemaVersion

      • id

        NotificationEvent.Builder id​(String id)

        The unique identifier for a NotificationEvent.

        Parameters:
        id - The unique identifier for a NotificationEvent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceEventMetadata

        NotificationEvent.Builder sourceEventMetadata​(SourceEventMetadata sourceEventMetadata)

        The source event metadata.

        Parameters:
        sourceEventMetadata - The source event metadata.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageComponents

        NotificationEvent.Builder messageComponents​(MessageComponents messageComponents)
        Sets the value of the MessageComponents property for this object.
        Parameters:
        messageComponents - The new value for the MessageComponents property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceEventDetailUrl

        NotificationEvent.Builder sourceEventDetailUrl​(String sourceEventDetailUrl)

        The source event URL.

        Parameters:
        sourceEventDetailUrl - The source event URL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceEventDetailUrlDisplayText

        NotificationEvent.Builder sourceEventDetailUrlDisplayText​(String sourceEventDetailUrlDisplayText)

        The detailed URL for the source event.

        Parameters:
        sourceEventDetailUrlDisplayText - The detailed URL for the source event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationType

        NotificationEvent.Builder notificationType​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NotificationType, NotificationType

      • notificationType

        NotificationEvent.Builder notificationType​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NotificationType, NotificationType

      • eventStatus

        NotificationEvent.Builder eventStatus​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EventStatus, EventStatus

      • eventStatus

        NotificationEvent.Builder eventStatus​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EventStatus, EventStatus

      • aggregationEventType

        NotificationEvent.Builder aggregationEventType​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationEventType, AggregationEventType

      • aggregationEventType

        NotificationEvent.Builder aggregationEventType​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationEventType, AggregationEventType

      • aggregateNotificationEventArn

        NotificationEvent.Builder aggregateNotificationEventArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • aggregationSummary

        NotificationEvent.Builder aggregationSummary​(AggregationSummary aggregationSummary)

        Provides additional information about how multiple notifications are grouped.

        Parameters:
        aggregationSummary - Provides additional information about how multiple notifications are grouped.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        NotificationEvent.Builder startTime​(Instant startTime)

        The notification event start time.

        Parameters:
        startTime - The notification event start time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        NotificationEvent.Builder endTime​(Instant endTime)

        The end time of the event.

        Parameters:
        endTime - The end time of the event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • textParts

        NotificationEvent.Builder textParts​(Map<String,​TextPartValue> textParts)

        A list of text values.

        Parameters:
        textParts - A list of text values.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • media

        NotificationEvent.Builder media​(Collection<MediaElement> media)

        A list of media elements.

        Parameters:
        media - A list of media elements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • media

        NotificationEvent.Builder media​(MediaElement... media)

        A list of media elements.

        Parameters:
        media - A list of media elements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.