Package io.github.primelib.jira4j.restv2.spec

Class GetIssuePickerResourceOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.GetIssuePickerResourceOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetIssuePickerResourceOperationSpec extends Object
GetIssuePickerResourceSpec

Specification for the GetIssuePickerResource operation.

Get issue picker suggestions

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetIssuePickerResourceOperationSpec

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

    • GetIssuePickerResourceOperationSpec

      @Internal public GetIssuePickerResourceOperationSpec(String query, String currentJQL, String currentIssueKey, String currentProjectId, Boolean showSubTasks, Boolean showSubTaskParent)
      Constructs a validated instance of GetIssuePickerResourceOperationSpec.

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

      Parameters:
      query - A string to match against text fields in the issue such as title, description, or comments.
      currentJQL - A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
      currentIssueKey - The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
      currentProjectId - The ID of a project that suggested issues must belong to.
      showSubTasks - Indicate whether to include subtasks in the suggestions list.
      showSubTaskParent - When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

    • GetIssuePickerResourceOperationSpec

      protected GetIssuePickerResourceOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetIssuePickerResourceOperationSpec.GetIssuePickerResourceOperationSpecBuilder builder()

    • query

      @Nullable public @Nullable String query()
      A string to match against text fields in the issue such as title, description, or comments.

    • currentJQL

      @Nullable public @Nullable String currentJQL()
      A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.

    • currentIssueKey

      @Nullable public @Nullable String currentIssueKey()
      The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.

    • currentProjectId

      @Nullable public @Nullable String currentProjectId()
      The ID of a project that suggested issues must belong to.

    • showSubTasks

      @Nullable public @Nullable Boolean showSubTasks()
      Indicate whether to include subtasks in the suggestions list.

    • showSubTaskParent

      @Nullable public @Nullable Boolean showSubTaskParent()
      When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

    • query

      public GetIssuePickerResourceOperationSpec query(@Nullable @Nullable String query)
      A string to match against text fields in the issue such as title, description, or comments.
      Returns:
      this.

    • currentJQL

      public GetIssuePickerResourceOperationSpec currentJQL(@Nullable @Nullable String currentJQL)
      A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
      Returns:
      this.

    • currentIssueKey

      public GetIssuePickerResourceOperationSpec currentIssueKey(@Nullable @Nullable String currentIssueKey)
      The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
      Returns:
      this.

    • currentProjectId

      public GetIssuePickerResourceOperationSpec currentProjectId(@Nullable @Nullable String currentProjectId)
      The ID of a project that suggested issues must belong to.
      Returns:
      this.

    • showSubTasks

      public GetIssuePickerResourceOperationSpec showSubTasks(@Nullable @Nullable Boolean showSubTasks)
      Indicate whether to include subtasks in the suggestions list.
      Returns:
      this.

    • showSubTaskParent

      public GetIssuePickerResourceOperationSpec showSubTaskParent(@Nullable @Nullable Boolean showSubTaskParent)
      When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.
      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