Package io.github.primelib.jira4j.restv3.spec

Class GetScreensForFieldOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv3.spec.GetScreensForFieldOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetScreensForFieldOperationSpec extends Object
GetScreensForFieldSpec

Specification for the GetScreensForField operation.

Get screens for a field

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetScreensForFieldOperationSpec

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

    • GetScreensForFieldOperationSpec

      @Internal public GetScreensForFieldOperationSpec(String fieldId, Long startAt, Integer maxResults, String expand)
      Constructs a validated instance of GetScreensForFieldOperationSpec.

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

      Parameters:
      fieldId - The ID of the field to return screens for.
      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.
      expand - Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.

    • GetScreensForFieldOperationSpec

      protected GetScreensForFieldOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetScreensForFieldOperationSpec.GetScreensForFieldOperationSpecBuilder builder()

    • fieldId

      @NotNull public @NotNull String fieldId()
      The ID of the field to return screens for.

    • 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.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.

    • fieldId

      public GetScreensForFieldOperationSpec fieldId(@NotNull @NotNull String fieldId)
      The ID of the field to return screens for.
      Returns:
      this.

    • startAt

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

    • maxResults

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

    • expand

      public GetScreensForFieldOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.
      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