Package com.qtsurfer.api.client.model

Class DeclaredProperty

java.lang.Object
com.qtsurfer.api.client.model.DeclaredProperty
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class DeclaredProperty extends Object
One property name `POST /strategy` could establish without constructing the strategy — either declared with `@StrategyProperty` on the compiled source, or one of the small set of base properties every strategy carries (`amnt`, `enabled`, `multiEntry`, ...). **Best-effort, not exhaustive.** A property registered through an attached risk/backtest config needs a live instance to discover and is not listed here. Use this to catch a typo'd sweep key before submitting, not as the definitive list of what a sweep will accept — a name absent from this list may still be valid.

  • Field Details

  • Constructor Details

    • DeclaredProperty

      public DeclaredProperty()

  • Method Details

    • name

      public DeclaredProperty name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      The key a sweep or execute param map uses for this property.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • description

      public DeclaredProperty description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Human-readable label, as declared.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • defaultValue

      public DeclaredProperty defaultValue(@Nullable String defaultValue)

    • getDefaultValue

      @Nullable public String getDefaultValue()
      The declared default, as a string, if one was given. Absent, not null, when none was declared.
      Returns:
      defaultValue

    • setDefaultValue

      public void setDefaultValue(@Nullable String defaultValue)

    • reflected

      public DeclaredProperty reflected(@Nullable Boolean reflected)

    • getReflected

      @Nullable public Boolean getReflected()
      Whether a value for this key is injected into the strategy's field (`true`) or only available through the property map (`false`).
      Returns:
      reflected

    • setReflected

      public void setReflected(@Nullable Boolean reflected)

    • min

      public DeclaredProperty min(@Nullable Double min)

    • getMin

      @Nullable public Double getMin()
      Suggested sweep/range minimum, if declared. Advisory only, never validated.
      Returns:
      min

    • setMin

      public void setMin(@Nullable Double min)

    • max

      public DeclaredProperty max(@Nullable Double max)

    • getMax

      @Nullable public Double getMax()
      Suggested sweep/range maximum, if declared. Advisory only, never validated.
      Returns:
      max

    • setMax

      public void setMax(@Nullable Double max)

    • step

      public DeclaredProperty step(@Nullable Double step)

    • getStep

      @Nullable public Double getStep()
      Suggested sweep/range step, if declared. Advisory only, never validated.
      Returns:
      step

    • setStep

      public void setStep(@Nullable Double step)

    • equals

      public boolean equals(Object o)
      Return true if this DeclaredProperty object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string