io.github.primelib.jira4j.restv2.spec.GetSecurityLevelMembersOperationSpec Maven / Gradle / Ivy
Show all versions of jira4j-rest-v2 Show documentation
package io.github.primelib.jira4j.restv2.spec;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Nullable;
import javax.annotation.processing.Generated;
import io.github.primelib.jira4j.restv2.model.SecurityLevel;
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;
/**
* GetSecurityLevelMembersSpec
*
* Specification for the GetSecurityLevelMembers operation.
*
* Get issue security level members
*/
@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 GetSecurityLevelMembersOperationSpec {
/**
* allows to disable validation of the spec, use with care!
*/
@ApiStatus.Experimental
public static Boolean VALIDATION_ENABLED = true;
/**
* The index of the first item to return in a page of results (page offset).
*/
@Nullable
private String startAt;
/**
* The maximum number of items to return per page.
*/
@Nullable
private String maxResults;
/**
* The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: {@code id=10000&id=10001}.
*/
@Nullable
private Set id;
/**
* The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: {@code schemeId=10000&schemeId=10001}.
*/
@Nullable
private Set schemeId;
/**
* The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: {@code levelId=10000&levelId=10001}.
*/
@Nullable
private Set levelId;
/**
* Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
* *
* {@code all} Returns all expandable information
* *
* {@code field} Returns information about the custom field granted the permission
* *
* {@code group} Returns information about the group that is granted the permission
* *
* {@code projectRole} Returns information about the project role granted the permission
* *
* {@code user} Returns information about the user who is granted the permission
*/
@Nullable
private String expand;
/**
* Constructs a validated instance of {@link GetSecurityLevelMembersOperationSpec}.
*
* @param spec the specification to process
*/
@ApiStatus.Internal
public GetSecurityLevelMembersOperationSpec(Consumer spec) {
spec.accept(this);
if (VALIDATION_ENABLED)
validate();
}
/**
* Constructs a validated instance of {@link GetSecurityLevelMembersOperationSpec}.
*
* NOTE: This constructor is not considered stable and may change if the operation is updated.
* @param startAt The index of the first item to return in a page of results (page offset).
* @param maxResults The maximum number of items to return per page.
* @param id The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: {@code id=10000&id=10001}.
* @param schemeId The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: {@code schemeId=10000&schemeId=10001}.
* @param levelId The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: {@code levelId=10000&levelId=10001}.
* @param expand Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * {@code all} Returns all expandable information * {@code field} Returns information about the custom field granted the permission * {@code group} Returns information about the group that is granted the permission * {@code projectRole} Returns information about the project role granted the permission * {@code user} Returns information about the user who is granted the permission
*/
@ApiStatus.Internal
public GetSecurityLevelMembersOperationSpec(String startAt, String maxResults, Set id, Set schemeId, Set levelId, String expand) {
this.startAt = startAt;
this.maxResults = maxResults;
this.id = id;
this.schemeId = schemeId;
this.levelId = levelId;
this.expand = expand;
if (VALIDATION_ENABLED)
validate();
}
/**
* Validates the Spec, will throw a exception if required parameters are missing
*
* @throws NullPointerException
*/
public void validate() {
}
}