Package com.atlassian.bitbucket.build.server.operations

Interface ActionResult

public interface ActionResult
The result of a request from Bitbucket to a CI system to perform a certain action.
Since:
7.8

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    getMessage()
    Optional additional message relating to the action invocation.
    ActionState
    getState()
    Returns the state of the action.
    Optional<URI>
    getURI()
    Optional URI that can contain more information about the request.

  • Method Details

    • getMessage

      @Nonnull Optional<String> getMessage()
      Optional additional message relating to the action invocation. For a failure it can contain additional information about why it failed. For successful invocations it can contain additional information about the action.
      Returns:
      additional message if one is available

    • getState

      @Nonnull ActionState getState()
      Returns the state of the action.
      Returns:
      final state of the action

    • getURI

      @Nonnull Optional<URI> getURI()
      Optional URI that can contain more information about the request. For a successful invocation it could be a link to the new (if such is created) build. For failure it can contain a link with more information about the failure.
      Returns:
      uri for the action