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

Class GetProjectComponentsPaginatedOperationSpec

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

Specification for the GetProjectComponentsPaginated operation.

Get project components paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetProjectComponentsPaginatedOperationSpec

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

    • GetProjectComponentsPaginatedOperationSpec

      @Internal public GetProjectComponentsPaginatedOperationSpec(String projectIdOrKey, Long startAt, Integer maxResults, String orderBy, String componentSource, String query)
      Constructs a validated instance of GetProjectComponentsPaginatedOperationSpec.

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

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive).
      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.
      orderBy - [Order](#ordering) the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name.
      componentSource - The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.
      query - Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

    • GetProjectComponentsPaginatedOperationSpec

      protected GetProjectComponentsPaginatedOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetProjectComponentsPaginatedOperationSpec.GetProjectComponentsPaginatedOperationSpecBuilder builder()

    • projectIdOrKey

      @NotNull public @NotNull String projectIdOrKey()
      The project ID or project key (case sensitive).

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

    • orderBy

      @Nullable public @Nullable String orderBy()
      [Order](#ordering) the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name.

    • componentSource

      @Nullable public @Nullable String componentSource()
      The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

    • query

      @Nullable public @Nullable String query()
      Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

    • projectIdOrKey

      public GetProjectComponentsPaginatedOperationSpec projectIdOrKey(@NotNull @NotNull String projectIdOrKey)
      The project ID or project key (case sensitive).
      Returns:
      this.

    • startAt

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

    • maxResults

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

    • orderBy

      public GetProjectComponentsPaginatedOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name.
      Returns:
      this.

    • componentSource

      public GetProjectComponentsPaginatedOperationSpec componentSource(@Nullable @Nullable String componentSource)
      The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.
      Returns:
      this.

    • query

      public GetProjectComponentsPaginatedOperationSpec query(@Nullable @Nullable String query)
      Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).
      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