Package com.qtsurfer.api.client.model

Class Exchange

java.lang.Object
com.qtsurfer.api.client.model.Exchange
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class Exchange extends Object
Exchange service provider

  • Field Details

  • Constructor Details

    • Exchange

      public Exchange()

  • Method Details

    • id

      public Exchange id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Unique identifier for the exchange
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • name

      public Exchange name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Name of the exchange
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • description

      public Exchange description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Description of the exchange
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • venueType

      public Exchange venueType(@Nonnull Exchange.VenueTypeEnum venueType)

    • getVenueType

      @Nonnull public Exchange.VenueTypeEnum getVenueType()
      Venue category, written as the `venueType` of a live run's source: `cex` is a centralized exchange and `dex` a decentralized one. A `dex` exchange has no market data to prepare or backtest, so its id is not valid in the routes that take an `exchangeId`, except the two instruments routes, which list its pools (the instrument of a run on it is a pool's address).
      Returns:
      venueType

    • setVenueType

      public void setVenueType(@Nonnull Exchange.VenueTypeEnum venueType)

    • segments

      public Exchange segments(@Nonnull Set<String> segments)

    • addSegmentsItem

      public Exchange addSegmentsItem(String segmentsItem)

    • getSegments

      @Nonnull public Set<String> getSegments()
      The segments the exchange offers, written as in the path of `GET /exchange/{exchangeId}/{segment}/instruments` and as the `segment` of a live run's source. For a `cex` exchange, its market segments (`spot`, `futures`: the ones its instrument catalogues are served under); for a `dex` exchange, the protocols whose pools a run can read.
      Returns:
      segments

    • setSegments

      public void setSegments(@Nonnull Set<String> segments)

    • liveSegments

      public Exchange liveSegments(@Nonnull Set<String> liveSegments)

    • addLiveSegmentsItem

      public Exchange addLiveSegmentsItem(String liveSegmentsItem)

    • getLiveSegments

      @Nonnull public Set<String> getLiveSegments()
      The segments among `segments` for which live data is published, so the ones a live run can read: a live run on any other segment of the exchange is refused with `400`. It can be empty (an exchange whose live data is not published yet).
      Returns:
      liveSegments

    • setLiveSegments

      public void setLiveSegments(@Nonnull Set<String> liveSegments)

    • equals

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