io.github.primelib.jira4j.restv3.spec.GetIssueOperationSpec Maven / Gradle / Ivy
Show all versions of jira4j-rest-v3 Show documentation
package io.github.primelib.jira4j.restv3.spec;
import java.util.List;
import java.util.Objects;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.annotation.processing.Generated;
import io.github.primelib.jira4j.restv3.model.Project;
import java.util.Set;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import java.util.function.Consumer;
/**
* GetIssueSpec
*
* Specification for the GetIssue operation.
*
* Get issue
*/
@Getter
@Setter
@EqualsAndHashCode
@ToString
@Accessors(fluent = true, chain = true)
@NoArgsConstructor(access = AccessLevel.PROTECTED, force = true)
@Builder
@Generated(value = "io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class GetIssueOperationSpec {
/**
* allows to disable validation of the spec, use with care!
*/
@ApiStatus.Experimental
public static Boolean VALIDATION_ENABLED = true;
/**
* The ID or key of the issue.
*/
@NotNull
private String issueIdOrKey;
/**
* 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:
* *
* {@code *all} Returns all fields.
* *
* {@code *navigable} Returns navigable fields.
* *
* Any issue field, prefixed with a minus to exclude.
* Examples:
* *
* {@code summary,comment} Returns only the summary and comments fields.
* *
* {@code -description} Returns all (default) fields except description.
* *
* {@code *navigable,-comment} Returns all navigable fields except comment.
* This parameter may be specified multiple times. For example, {@code fields=field1,field2& fields=field3}.
* Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields.
*/
@Nullable
private List fields;
/**
* Whether fields in {@code 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.
*/
@Nullable
private Boolean fieldsByKeys;
/**
* Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:
* *
* {@code renderedFields} Returns field values rendered in HTML format.
* *
* {@code names} Returns the display name of each field.
* *
* {@code schema} Returns the schema describing a field type.
* *
* {@code transitions} Returns all possible transitions for the issue.
* *
* {@code editmeta} Returns information about how each field can be edited.
* *
* {@code changelog} Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
* *
* {@code 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 {@code fields} parameter is ignored.
*/
@Nullable
private String expand;
/**
* A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:
* *
* {@code *all} Returns all issue properties.
* *
* Any issue property key, prefixed with a minus to exclude.
* Examples:
* *
* {@code *all} Returns all properties.
* *
* {@code *all,-prop1} Returns all properties except {@code prop1}.
* *
* {@code prop1,prop2} Returns {@code prop1} and {@code prop2} properties.
* This parameter may be specified multiple times. For example, {@code properties=prop1,prop2& properties=prop3}.
*/
@Nullable
private List properties;
/**
* 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-3-search-get) {@code lastViewed} field.
*/
@Nullable
private Boolean updateHistory;
/**
* Constructs a validated instance of {@link GetIssueOperationSpec}.
*
* @param spec the specification to process
*/
@ApiStatus.Internal
public GetIssueOperationSpec(Consumer spec) {
spec.accept(this);
if (VALIDATION_ENABLED)
validate();
}
/**
* Constructs a validated instance of {@link GetIssueOperationSpec}.
*
* NOTE: This constructor is not considered stable and may change if the operation is updated.
* @param issueIdOrKey The ID or key of the issue.
* @param 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: * {@code *all} Returns all fields. * {@code *navigable} Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * {@code summary,comment} Returns only the summary and comments fields. * {@code -description} Returns all (default) fields except description. * {@code *navigable,-comment} Returns all navigable fields except comment. This parameter may be specified multiple times. For example, {@code fields=field1,field2& fields=field3}. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields.
* @param fieldsByKeys Whether fields in {@code 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.
* @param expand Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * {@code renderedFields} Returns field values rendered in HTML format. * {@code names} Returns the display name of each field. * {@code schema} Returns the schema describing a field type. * {@code transitions} Returns all possible transitions for the issue. * {@code editmeta} Returns information about how each field can be edited. * {@code changelog} Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * {@code 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 {@code fields} parameter is ignored.
* @param properties A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * {@code *all} Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * {@code *all} Returns all properties. * {@code *all,-prop1} Returns all properties except {@code prop1}. * {@code prop1,prop2} Returns {@code prop1} and {@code prop2} properties. This parameter may be specified multiple times. For example, {@code properties=prop1,prop2& properties=prop3}.
* @param 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-3-search-get) {@code lastViewed} field.
*/
@ApiStatus.Internal
public GetIssueOperationSpec(String issueIdOrKey, List fields, Boolean fieldsByKeys, String expand, List properties, Boolean updateHistory) {
this.issueIdOrKey = issueIdOrKey;
this.fields = fields;
this.fieldsByKeys = fieldsByKeys;
this.expand = expand;
this.properties = properties;
this.updateHistory = updateHistory;
if (VALIDATION_ENABLED)
validate();
}
/**
* Validates the Spec, will throw a exception if required parameters are missing
*
* @throws NullPointerException
*/
public void validate() {
Objects.requireNonNull(issueIdOrKey, "issueIdOrKey is a required parameter!");
}
}