Package com.atlassian.bamboo.webhook

Interface WebhookResponseDetails

All Superinterfaces:
BambooIdProvider, BambooObject, WebhookResponse
All Known Implementing Classes:
WebhookResponseDetailsEntity
public interface WebhookResponseDetails extends WebhookResponse, BambooObject

  • Method Details

    • getRequestBody

      String getRequestBody()
      Returns:
      body of sent webhook.

    • getRequestHeaders

      String getRequestHeaders()
      Returns:
      headers of sent webhook.

    • getResponseBody

      @Nullable String getResponseBody()
      Returns:
      body of received response.

    • getResponseHeaders

      @Nullable String getResponseHeaders()
      Returns:
      headers of received response.

    • getMessage

      @Nullable String getMessage()
      Returns:
      message about errors during sending webhook.

    • setResponseBody

      void setResponseBody(String responseBody)
      Set response body of webhook response.
      Parameters:
      responseBody - body of received response.

    • setResponseHeaders

      void setResponseHeaders(String responseHeaders)
      Set response headers of webhook response.
      Parameters:
      responseHeaders - headers of received response.

    • setStatusCode

      void setStatusCode(Integer statusCode)
      Set status code of received webhook response.
      Parameters:
      statusCode - status code of received response

    • setResponseStatus

      void setResponseStatus(WebhookResponseStatus responseStatus)
      Set status of webhook response.
      Parameters:
      responseStatus - status of webhook response. Possible values: "PENDING", "ERROR", "TIMEOUT", "FINISHED".

    • setReceiveTime

      void setReceiveTime(Date receiveTime)
      Set time of receiving webhook response.
      Parameters:
      receiveTime - time in the moment when response status is changed from "PENDING" to any other state.

    • setMessage

      void setMessage(String message)
      Set a informative message about why webhook response was "TIMEOUT" or "ERROR"
      Parameters:
      message - information about failure of webhook response