Package io.github.primelib.jira4j.restv3.spec

Class GetTransitionsOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv3.spec.GetTransitionsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetTransitionsOperationSpec extends Object
GetTransitionsSpec

Specification for the GetTransitions operation.

Get transitions

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

    • GetTransitionsOperationSpec

      @Internal public GetTransitionsOperationSpec(Consumer<GetTransitionsOperationSpec> spec)
      Constructs a validated instance of GetTransitionsOperationSpec.
      Parameters:
      spec - the specification to process

    • GetTransitionsOperationSpec

      @Internal public GetTransitionsOperationSpec(String issueIdOrKey, String expand, String transitionId, Boolean skipRemoteOnlyCondition, Boolean includeUnavailableTransitions, Boolean sortByOpsBarAndStatus)
      Constructs a validated instance of GetTransitionsOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameters:
      issueIdOrKey - The ID or key of the issue.
      expand - Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post).
      transitionId - The ID of the transition.
      skipRemoteOnlyCondition - Whether transitions with the condition *Hide From User Condition* are included in the response.
      includeUnavailableTransitions - Whether details of transitions that fail a condition are included in the response
      sortByOpsBarAndStatus - Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.

    • GetTransitionsOperationSpec

      protected GetTransitionsOperationSpec()

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • builder

      public static GetTransitionsOperationSpec.GetTransitionsOperationSpecBuilder builder()

    • issueIdOrKey

      @NotNull public @NotNull String issueIdOrKey()
      The ID or key of the issue.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post).

    • transitionId

      @Nullable public @Nullable String transitionId()
      The ID of the transition.

    • skipRemoteOnlyCondition

      @Nullable public @Nullable Boolean skipRemoteOnlyCondition()
      Whether transitions with the condition *Hide From User Condition* are included in the response.

    • includeUnavailableTransitions

      @Nullable public @Nullable Boolean includeUnavailableTransitions()
      Whether details of transitions that fail a condition are included in the response

    • sortByOpsBarAndStatus

      @Nullable public @Nullable Boolean sortByOpsBarAndStatus()
      Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.

    • issueIdOrKey

      public GetTransitionsOperationSpec issueIdOrKey(@NotNull @NotNull String issueIdOrKey)
      The ID or key of the issue.
      Returns:
      this.

    • expand

      public GetTransitionsOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post).
      Returns:
      this.

    • transitionId

      public GetTransitionsOperationSpec transitionId(@Nullable @Nullable String transitionId)
      The ID of the transition.
      Returns:
      this.

    • skipRemoteOnlyCondition

      public GetTransitionsOperationSpec skipRemoteOnlyCondition(@Nullable @Nullable Boolean skipRemoteOnlyCondition)
      Whether transitions with the condition *Hide From User Condition* are included in the response.
      Returns:
      this.

    • includeUnavailableTransitions

      public GetTransitionsOperationSpec includeUnavailableTransitions(@Nullable @Nullable Boolean includeUnavailableTransitions)
      Whether details of transitions that fail a condition are included in the response
      Returns:
      this.

    • sortByOpsBarAndStatus

      public GetTransitionsOperationSpec sortByOpsBarAndStatus(@Nullable @Nullable Boolean sortByOpsBarAndStatus)
      Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object