Class NotificationEventSummary

    • Method Detail

      • 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, schemaVersion will return SchemaVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schemaVersionAsString().

        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 EventRules are ACTIVE.

          • UNHEALTHY

            • Some EventRules are ACTIVE and some are INACTIVE.

        If the service returns an enum value that is not available in the current SDK version, eventStatus will return EventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventStatusAsString().

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

        See Also:
        EventStatus
      • eventStatusAsString

        public final String eventStatusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, eventStatus will return EventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventStatusAsString().

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

        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, notificationType will return NotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationTypeAsString().

        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, notificationType will return NotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationTypeAsString().

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

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)