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

Class GetIssueOperationSpec

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

Specification for the GetIssue operation.

Get issue

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetIssueOperationSpec

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

    • GetIssueOperationSpec

      @Internal public GetIssueOperationSpec(String issueIdOrKey, List<String> fields, Boolean fieldsByKeys, String expand, List<String> properties, Boolean updateHistory)
      Constructs a validated instance of GetIssueOperationSpec.

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

      Parameters:
      issueIdOrKey - The ID or key of the issue.
      fields - A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all (default) fields except description. * *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2&amp; fields=field3. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-2-search-get) and [Search for issues using JQL (POST)](#api-rest-api-2-search-post) where the default is all navigable fields.
      fieldsByKeys - Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
      expand - Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.
      properties - A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * *all Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * *all Returns all properties. * *all,-prop1 Returns all properties except prop1. * prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2&amp; properties=prop3.
      updateHistory - Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-2-search-get) lastViewed field.

    • GetIssueOperationSpec

      protected GetIssueOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetIssueOperationSpec.GetIssueOperationSpecBuilder builder()

    • issueIdOrKey

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

    • fields

      @Nullable public @Nullable List<String> fields()
      A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all (default) fields except description. * *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2&amp; fields=field3. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-2-search-get) and [Search for issues using JQL (POST)](#api-rest-api-2-search-post) where the default is all navigable fields.

    • fieldsByKeys

      @Nullable public @Nullable Boolean fieldsByKeys()
      Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.

    • properties

      @Nullable public @Nullable List<String> properties()
      A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * *all Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * *all Returns all properties. * *all,-prop1 Returns all properties except prop1. * prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2&amp; properties=prop3.

    • updateHistory

      @Nullable public @Nullable Boolean updateHistory()
      Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-2-search-get) lastViewed field.

    • issueIdOrKey

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

    • fields

      public GetIssueOperationSpec fields(@Nullable @Nullable List<String> fields)
      A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all (default) fields except description. * *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2&amp; fields=field3. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-2-search-get) and [Search for issues using JQL (POST)](#api-rest-api-2-search-post) where the default is all navigable fields.
      Returns:
      this.

    • fieldsByKeys

      public GetIssueOperationSpec fieldsByKeys(@Nullable @Nullable Boolean fieldsByKeys)
      Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
      Returns:
      this.

    • expand

      public GetIssueOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.
      Returns:
      this.

    • properties

      public GetIssueOperationSpec properties(@Nullable @Nullable List<String> properties)
      A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * *all Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * *all Returns all properties. * *all,-prop1 Returns all properties except prop1. * prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2&amp; properties=prop3.
      Returns:
      this.

    • updateHistory

      public GetIssueOperationSpec updateHistory(@Nullable @Nullable Boolean updateHistory)
      Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-2-search-get) lastViewed field.
      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