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

Class GetProjectComponentsOperationSpec

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

Specification for the GetProjectComponents operation.

Get project components

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetProjectComponentsOperationSpec

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

    • GetProjectComponentsOperationSpec

      @Internal public GetProjectComponentsOperationSpec(String projectIdOrKey, String componentSource)
      Constructs a validated instance of GetProjectComponentsOperationSpec.

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

    • GetProjectComponentsOperationSpec

      protected GetProjectComponentsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetProjectComponentsOperationSpec.GetProjectComponentsOperationSpecBuilder builder()

    • projectIdOrKey

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

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

    • projectIdOrKey

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

    • componentSource

      public GetProjectComponentsOperationSpec 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.

    • 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