Package com.atlassian.bamboo.notification

Interface NotificationRecipientExporter

All Known Implementing Classes:
DefaultNotificationRecipientExporter, EmailRecipientExporter, GroupRecipientExporter, ImRecipientExporter, UserRecipientExporter, WebhookRecipientExporter
public interface NotificationRecipientExporter

  • Method Summary

    Modifier and Type
    Method
    Description
    default com.atlassian.bamboo.specs.api.builders.notification.NotificationRecipient<?,?>
    fromYaml(@NotNull Node recipientsNode)
    Read YAML node and return NotificationRecipient if found.
    @NotNull String
    importNotificationRecipient(com.atlassian.bamboo.specs.api.model.notification.NotificationRecipientProperties recipient)
     
    @NotNull com.atlassian.bamboo.specs.api.builders.notification.NotificationRecipient
    toSpecsEntity(@NotNull String recipientKey, @NotNull String recipientData)
     
    default @Nullable Node
    toYaml(com.atlassian.bamboo.specs.api.model.notification.NotificationRecipientProperties recipient)
    Produce YAML node and return NotificationRecipient configuration.

  • Method Details

    • toSpecsEntity

      @NotNull @NotNull com.atlassian.bamboo.specs.api.builders.notification.NotificationRecipient toSpecsEntity(@NotNull @NotNull String recipientKey, @NotNull @NotNull String recipientData)

    • importNotificationRecipient

      @NotNull @NotNull String importNotificationRecipient(com.atlassian.bamboo.specs.api.model.notification.NotificationRecipientProperties recipient)

    • fromYaml

      @Nullable default com.atlassian.bamboo.specs.api.builders.notification.NotificationRecipient<?,?> fromYaml(@NotNull @NotNull Node recipientsNode)
      Read YAML node and return NotificationRecipient if found.
      Parameters:
      recipientsNode - yaml structure with recipients settings
      Returns:
      Specs recipient entity
      Since:
      7.1

    • toYaml

      @Nullable default @Nullable Node toYaml(com.atlassian.bamboo.specs.api.model.notification.NotificationRecipientProperties recipient)
      Produce YAML node and return NotificationRecipient configuration.
      Parameters:
      recipient - settings
      Returns:
      YAML Node which contain representation of Bamboo Specs entity.
      Since:
      7.1