io.github.primelib.jira4j.restv2.spec.CreateIssueFieldOptionOperationSpec Maven / Gradle / Ivy
Show all versions of jira4j-rest-v2 Show documentation
package io.github.primelib.jira4j.restv2.spec;
import java.util.Objects;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import javax.annotation.processing.Generated;
import io.github.primelib.jira4j.restv2.model.IssueFieldOption;
import io.github.primelib.jira4j.restv2.model.IssueFieldOptionCreateBean;
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;
/**
* CreateIssueFieldOptionSpec
*
* Specification for the CreateIssueFieldOption operation.
*
* Create issue field option
*/
@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 CreateIssueFieldOptionOperationSpec {
/**
* allows to disable validation of the spec, use with care!
*/
@ApiStatus.Experimental
public static Boolean VALIDATION_ENABLED = true;
/**
* The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following:
* *
* open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.
* *
* run [Get fields](#api-rest-api-2-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"}
*/
@NotNull
private String fieldKey;
/**
*/
@NotNull
private IssueFieldOptionCreateBean issueFieldOptionCreateBean;
/**
* Constructs a validated instance of {@link CreateIssueFieldOptionOperationSpec}.
*
* @param spec the specification to process
*/
@ApiStatus.Internal
public CreateIssueFieldOptionOperationSpec(Consumer spec) {
spec.accept(this);
if (VALIDATION_ENABLED)
validate();
}
/**
* Constructs a validated instance of {@link CreateIssueFieldOptionOperationSpec}.
*
* NOTE: This constructor is not considered stable and may change if the operation is updated.
* @param fieldKey The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the {@code fieldKey} value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the {@code jiraIssueFields} module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-2-field-get) and in the field details the value is returned in {@code key}. For example, {@code "key": "teams-add-on__team-issue-field"}
* @param issueFieldOptionCreateBean
*/
@ApiStatus.Internal
public CreateIssueFieldOptionOperationSpec(String fieldKey, IssueFieldOptionCreateBean issueFieldOptionCreateBean) {
this.fieldKey = fieldKey;
this.issueFieldOptionCreateBean = issueFieldOptionCreateBean;
if (VALIDATION_ENABLED)
validate();
}
/**
* Validates the Spec, will throw a exception if required parameters are missing
*
* @throws NullPointerException
*/
public void validate() {
Objects.requireNonNull(fieldKey, "fieldKey is a required parameter!");
Objects.requireNonNull(issueFieldOptionCreateBean, "issueFieldOptionCreateBean is a required parameter!");
}
}