Package io.quarkus.smallrye.openapi

Enum Class OpenApiFilter.RunStage

java.lang.Object
java.lang.Enum<OpenApiFilter.RunStage>
io.quarkus.smallrye.openapi.OpenApiFilter.RunStage
All Implemented Interfaces:
Serializable, Comparable<OpenApiFilter.RunStage>, Constable
Enclosing class:
OpenApiFilter
public static enum OpenApiFilter.RunStage extends Enum<OpenApiFilter.RunStage>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BOTH
    Deprecated, for removal: This API element is subject to removal in a future version.
    Consider replacing with stages = {OpenApiFilter.RunStage.BUILD, OpenApiFilter.RunStage.RUNTIME_STARTUP} or stages = {OpenApiFilter.RunStage.BUILD, OpenApiFilter.RunStage.RUNTIME_PER_REQUEST}, depending on the value of the now also deprecated quarkus.smallrye-openapi.always-run-filter.
    BUILD
    Run the filter once at build time.
    RUN
    Deprecated, for removal: This API element is subject to removal in a future version.
    Consider replacing with either RUNTIME_STARTUP or RUNTIME_PER_REQUEST, depending on the value of the now also deprecated quarkus.smallrye-openapi.always-run-filter.
    RUNTIME_PER_REQUEST
    Run the filter on every request.
    RUNTIME_STARTUP
    Run the filter once at runtime startup.

  • Method Summary

    Modifier and Type
    Method
    Description
    static OpenApiFilter.RunStage
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OpenApiFilter.RunStage[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BUILD

      public static final OpenApiFilter.RunStage BUILD
      Run the filter once at build time.

    • RUN

      @Deprecated(since="3.32", forRemoval=true) public static final OpenApiFilter.RunStage RUN
      Deprecated, for removal: This API element is subject to removal in a future version.
      Consider replacing with either RUNTIME_STARTUP or RUNTIME_PER_REQUEST, depending on the value of the now also deprecated quarkus.smallrye-openapi.always-run-filter.

    • BOTH

      @Deprecated(since="3.32", forRemoval=true) public static final OpenApiFilter.RunStage BOTH
      Deprecated, for removal: This API element is subject to removal in a future version.
      Consider replacing with stages = {OpenApiFilter.RunStage.BUILD, OpenApiFilter.RunStage.RUNTIME_STARTUP} or stages = {OpenApiFilter.RunStage.BUILD, OpenApiFilter.RunStage.RUNTIME_PER_REQUEST}, depending on the value of the now also deprecated quarkus.smallrye-openapi.always-run-filter.

    • RUNTIME_STARTUP

      public static final OpenApiFilter.RunStage RUNTIME_STARTUP
      Run the filter once at runtime startup.

    • RUNTIME_PER_REQUEST

      public static final OpenApiFilter.RunStage RUNTIME_PER_REQUEST
      Run the filter on every request. This makes the OpenAPI document dynamic.

  • Method Details

    • values

      public static OpenApiFilter.RunStage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OpenApiFilter.RunStage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null