Interface NotificationEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NotificationEvent.Builder,NotificationEvent>, SdkBuilder<NotificationEvent.Builder,NotificationEvent>, SdkPojo
Enclosing class:
NotificationEvent
@Mutable @NotThreadSafe public static interface NotificationEvent.Builder extends SdkPojo, CopyableBuilder<NotificationEvent.Builder,NotificationEvent>

  • Method Details

    • 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

      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:

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

    • sourceEventMetadata

      default NotificationEvent.Builder sourceEventMetadata(Consumer<SourceEventMetadata.Builder> sourceEventMetadata)

      The source event metadata.

      This is a convenience method that creates an instance of the SourceEventMetadata.Builder avoiding the need to create one manually via SourceEventMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceEventMetadata(SourceEventMetadata).

      Parameters:
      sourceEventMetadata - a consumer that will call methods on SourceEventMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • messageComponents

      default NotificationEvent.Builder messageComponents(Consumer<MessageComponents.Builder> messageComponents)
      Sets the value of the MessageComponents property for this object. This is a convenience method that creates an instance of the MessageComponents.Builder avoiding the need to create one manually via MessageComponents.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageComponents(MessageComponents).

      Parameters:
      messageComponents - a consumer that will call methods on MessageComponents.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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

      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:

    • 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

      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:

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

    • aggregationSummary

      default NotificationEvent.Builder aggregationSummary(Consumer<AggregationSummary.Builder> aggregationSummary)

      Provides additional information about how multiple notifications are grouped.

      This is a convenience method that creates an instance of the AggregationSummary.Builder avoiding the need to create one manually via AggregationSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aggregationSummary(AggregationSummary).

      Parameters:
      aggregationSummary - a consumer that will call methods on AggregationSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • media

      NotificationEvent.Builder media(Consumer<MediaElement.Builder>... media)

      A list of media elements.

      This is a convenience method that creates an instance of the MediaElement.Builder avoiding the need to create one manually via MediaElement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(List<MediaElement>).

      Parameters:
      media - a consumer that will call methods on MediaElement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • organizationalUnitId

      NotificationEvent.Builder organizationalUnitId(String organizationalUnitId)

      The unique identifier of the organizational unit associated with the notification event.

      Parameters:
      organizationalUnitId - The unique identifier of the organizational unit associated with the notification event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.