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

Class GetContextsForFieldOperationSpec

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

Specification for the GetContextsForField operation.

Get custom field contexts

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetContextsForFieldOperationSpec

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

    • GetContextsForFieldOperationSpec

      @Internal public GetContextsForFieldOperationSpec(String fieldId, Boolean isAnyIssueType, Boolean isGlobalContext, Set<Long> contextId, Long startAt, Integer maxResults)
      Constructs a validated instance of GetContextsForFieldOperationSpec.

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

      Parameters:
      fieldId - The ID of the custom field.
      isAnyIssueType - Whether to return contexts that apply to all issue types.
      isGlobalContext - Whether to return contexts that apply to all projects.
      contextId - The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&amp;contextId=10001.
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page.

    • GetContextsForFieldOperationSpec

      protected GetContextsForFieldOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetContextsForFieldOperationSpec.GetContextsForFieldOperationSpecBuilder builder()

    • fieldId

      @NotNull public @NotNull String fieldId()
      The ID of the custom field.

    • isAnyIssueType

      @Nullable public @Nullable Boolean isAnyIssueType()
      Whether to return contexts that apply to all issue types.

    • isGlobalContext

      @Nullable public @Nullable Boolean isGlobalContext()
      Whether to return contexts that apply to all projects.

    • contextId

      @Nullable public @Nullable Set<Long> contextId()
      The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&amp;contextId=10001.

    • startAt

      @Nullable public @Nullable Long startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page.

    • fieldId

      public GetContextsForFieldOperationSpec fieldId(@NotNull @NotNull String fieldId)
      The ID of the custom field.
      Returns:
      this.

    • isAnyIssueType

      public GetContextsForFieldOperationSpec isAnyIssueType(@Nullable @Nullable Boolean isAnyIssueType)
      Whether to return contexts that apply to all issue types.
      Returns:
      this.

    • isGlobalContext

      public GetContextsForFieldOperationSpec isGlobalContext(@Nullable @Nullable Boolean isGlobalContext)
      Whether to return contexts that apply to all projects.
      Returns:
      this.

    • contextId

      public GetContextsForFieldOperationSpec contextId(@Nullable @Nullable Set<Long> contextId)
      The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&amp;contextId=10001.
      Returns:
      this.

    • startAt

      public GetContextsForFieldOperationSpec startAt(@Nullable @Nullable Long startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public GetContextsForFieldOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      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