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

Class GetWorkflowTransitionPropertiesOperationSpec

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

Specification for the GetWorkflowTransitionProperties operation.

Get workflow transition properties

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetWorkflowTransitionPropertiesOperationSpec

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

    • GetWorkflowTransitionPropertiesOperationSpec

      @Internal public GetWorkflowTransitionPropertiesOperationSpec(Long transitionId, String workflowName, Boolean includeReservedKeys, String key, String workflowMode)
      Constructs a validated instance of GetWorkflowTransitionPropertiesOperationSpec.

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

      Parameters:
      transitionId - The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
      workflowName - The name of the workflow that the transition belongs to.
      includeReservedKeys - Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.
      key - The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
      workflowMode - The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.

    • GetWorkflowTransitionPropertiesOperationSpec

      protected GetWorkflowTransitionPropertiesOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetWorkflowTransitionPropertiesOperationSpec.GetWorkflowTransitionPropertiesOperationSpecBuilder builder()

    • transitionId

      @NotNull public @NotNull Long transitionId()
      The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.

    • workflowName

      @NotNull public @NotNull String workflowName()
      The name of the workflow that the transition belongs to.

    • includeReservedKeys

      @Nullable public @Nullable Boolean includeReservedKeys()
      Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.

    • key

      @Nullable public @Nullable String key()
      The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.

    • workflowMode

      @Nullable public @Nullable String workflowMode()
      The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.

    • transitionId

      public GetWorkflowTransitionPropertiesOperationSpec transitionId(@NotNull @NotNull Long transitionId)
      The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
      Returns:
      this.

    • workflowName

      public GetWorkflowTransitionPropertiesOperationSpec workflowName(@NotNull @NotNull String workflowName)
      The name of the workflow that the transition belongs to.
      Returns:
      this.

    • includeReservedKeys

      public GetWorkflowTransitionPropertiesOperationSpec includeReservedKeys(@Nullable @Nullable Boolean includeReservedKeys)
      Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.
      Returns:
      this.

    • key

      public GetWorkflowTransitionPropertiesOperationSpec key(@Nullable @Nullable String key)
      The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
      Returns:
      this.

    • workflowMode

      public GetWorkflowTransitionPropertiesOperationSpec workflowMode(@Nullable @Nullable String workflowMode)
      The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.
      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