Package com.qtsurfer.api.client.model

Class EquityCurveRequest

java.lang.Object
com.qtsurfer.api.client.model.EquityCurveRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class EquityCurveRequest extends Object
Selection (`mode`/`n`/`maxPct`) plus the transform preference (`resample`/`differential`/`outMode`) applied by `GET .../equityCurve` whenever ITS OWN query params are absent, for a curve this sweep retained. The transform half never affects retention or `sweepId` — a caller can always override it per-request at read time regardless of what was submitted here.

  • Field Details

  • Constructor Details

    • EquityCurveRequest

      public EquityCurveRequest()

  • Method Details

    • resample

      public EquityCurveRequest resample(@Nullable Integer resample)

    • getResample

      @Nullable public Integer getResample()
      Downsample to at most this many points (extrema-preserving — the global max/min and the exact first/last point are always kept). Omit for no downsampling. minimum: 2
      Returns:
      resample

    • setResample

      public void setResample(@Nullable Integer resample)

    • differential

      public EquityCurveRequest differential(@Nullable Boolean differential)

    • getDifferential

      @Nullable public Boolean getDifferential()
      Delta-encode both fields from the second (post-resample) point onward.
      Returns:
      differential

    • setDifferential

      public void setDifferential(@Nullable Boolean differential)

    • outMode

      public EquityCurveRequest outMode(@Nullable EquityCurveOutMode outMode)

    • getOutMode

      @Nullable public EquityCurveOutMode getOutMode()
      Requested JSON shape.
      Returns:
      outMode

    • setOutMode

      public void setOutMode(@Nullable EquityCurveOutMode outMode)

    • mode

      public EquityCurveRequest mode(@Nullable EquityCurveRequest.ModeEnum mode)

    • getMode

      @Nullable public EquityCurveRequest.ModeEnum getMode()
      Which trials keep their per-point equity curve. `auto` retains curves only while the accumulated size stays within server limits; `topN`/`topPct` retain curves for the best-ranked trials explicitly; `none` retains no curves.
      Returns:
      mode

    • setMode

      public void setMode(@Nullable EquityCurveRequest.ModeEnum mode)

    • n

      public EquityCurveRequest n(@Nullable Integer n)

    • getN

      @Nullable public Integer getN()
      Trial count to retain when mode is topN. minimum: 1
      Returns:
      n

    • setN

      public void setN(@Nullable Integer n)

    • maxPct

      public EquityCurveRequest maxPct(@Nullable Double maxPct)

    • getMaxPct

      @Nullable public Double getMaxPct()
      Top percentage of trials to retain when mode is topPct. maximum: 100
      Returns:
      maxPct

    • setMaxPct

      public void setMaxPct(@Nullable Double maxPct)

    • equals

      public boolean equals(Object o)
      Return true if this EquityCurveRequest 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