Class GetIssueOperationSpec.GetIssueOperationSpecBuilder
java.lang.Object
io.github.primelib.jira4j.restv2.spec.GetIssueOperationSpec.GetIssueOperationSpecBuilder
- Enclosing class:
- GetIssueOperationSpec
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Use [expand](#expansion) to include additional information about the issues in the response.A list of fields to return for the issue.fieldsByKeys(@Nullable Boolean fieldsByKeys) Whether fields infieldsare referenced by keys rather than IDs.issueIdOrKey(@NotNull String issueIdOrKey) The ID or key of the issue.properties(@Nullable List<String> properties) A list of issue properties to return for the issue.toString()updateHistory(@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.
-
Method Details
-
issueIdOrKey
public GetIssueOperationSpec.GetIssueOperationSpecBuilder issueIdOrKey(@NotNull @NotNull String issueIdOrKey) The ID or key of the issue.- Returns:
this.
-
fields
public GetIssueOperationSpec.GetIssueOperationSpecBuilder 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: **allReturns all fields. **navigableReturns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: *summary,commentReturns only the summary and comments fields. *-descriptionReturns all (default) fields except description. **navigable,-commentReturns all navigable fields except comment. This parameter may be specified multiple times. For example,fields=field1,field2& 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.GetIssueOperationSpecBuilder fieldsByKeys(@Nullable @Nullable Boolean fieldsByKeys) Whether fields infieldsare 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
Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: *renderedFieldsReturns field values rendered in HTML format. *namesReturns the display name of each field. *schemaReturns the schema describing a field type. *transitionsReturns all possible transitions for the issue. *editmetaReturns information about how each field can be edited. *changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent. *versionedRepresentationsReturns 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, thefieldsparameter is ignored.- Returns:
this.
-
properties
public GetIssueOperationSpec.GetIssueOperationSpecBuilder 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: **allReturns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: **allReturns all properties. **all,-prop1Returns all properties exceptprop1. *prop1,prop2Returnsprop1andprop2properties. This parameter may be specified multiple times. For example,properties=prop1,prop2& properties=prop3.- Returns:
this.
-
updateHistory
public GetIssueOperationSpec.GetIssueOperationSpecBuilder 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)lastViewedfield.- Returns:
this.
-
build
-
toString
-