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

Klasse GetProjectComponentsPaginatedOperationSpec

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

Specification for the GetProjectComponentsPaginated operation.

Get project components paginated

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetProjectComponentsPaginatedOperationSpec

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

    • GetProjectComponentsPaginatedOperationSpec

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

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

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

    • GetProjectComponentsPaginatedOperationSpec

      protected GetProjectComponentsPaginatedOperationSpec()

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      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.

    • 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).
      Gibt zurück:
      this.

    • startAt

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

    • maxResults

      public GetProjectComponentsPaginatedOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Gibt zurück:
      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.
      Gibt zurück:
      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).
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object