Interface NotificationEventSummary.Builder

  • Method Details

    • schemaVersion

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

      NotificationEventSummary.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:
    • sourceEventMetadata

      NotificationEventSummary.Builder sourceEventMetadata(SourceEventMetadataSummary 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 NotificationEventSummary.Builder sourceEventMetadata(Consumer<SourceEventMetadataSummary.Builder> sourceEventMetadata)

      The source event metadata.

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

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

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

      NotificationEventSummary.Builder messageComponents(MessageComponentsSummary messageComponents)

      The message components of a notification event.

      Parameters:
      messageComponents - The message components of a notification event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messageComponents

      default NotificationEventSummary.Builder messageComponents(Consumer<MessageComponentsSummary.Builder> messageComponents)

      The message components of a notification event.

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

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

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

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

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

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

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

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

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

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