Class StartLiveRequest

java.lang.Object
com.qtsurfer.api.client.model.StartLiveRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class StartLiveRequest extends Object
StartLiveRequest
  • Field Details

  • Constructor Details

    • StartLiveRequest

      public StartLiveRequest()
  • Method Details

    • sources

      public StartLiveRequest sources(@Nonnull List<LiveSource> sources)
    • addSourcesItem

      public StartLiveRequest addSourcesItem(LiveSource sourcesItem)
    • getSources

      @Nonnull public List<LiveSource> getSources()
      Get sources
      Returns:
      sources
    • setSources

      public void setSources(@Nonnull List<LiveSource> sources)
    • params

      public StartLiveRequest params(@Nullable Object params)
    • getParams

      @Nullable public Object getParams()
      Strategy parameters to start with. Opaque key/value pairs — see this strategy's own `declaredProperties` (from `POST /strategy`) for the keys it accepts.
      Returns:
      params
    • setParams

      public void setParams(@Nullable Object params)
    • visibility

      public StartLiveRequest visibility(@Nullable StartLiveRequest.VisibilityEnum visibility)
    • getVisibility

      @Nullable public StartLiveRequest.VisibilityEnum getVisibility()
      A `public` run appears in `GET /live/public` and its signal channel accepts subscriptions from anyone, not only you.
      Returns:
      visibility
    • setVisibility

      public void setVisibility(@Nullable StartLiveRequest.VisibilityEnum visibility)
    • relay

      public StartLiveRequest relay(@Nullable Boolean relay)
    • getRelay

      @Nullable public Boolean getRelay()
      Request that this run's signals be relayed over its WebSocket channel once it reaches the `live` stage — see the \"Live execution\" guide. Has no effect while the run is still in the `sandbox` stage, regardless of this value.
      Returns:
      relay
    • setRelay

      public void setRelay(@Nullable Boolean relay)
    • name

      public StartLiveRequest name(@Nullable String name)
    • getName

      @Nullable public String getName()
      Get name
      Returns:
      name
    • setName

      public void setName(@Nullable String name)
    • description

      public StartLiveRequest description(@Nullable String description)
    • getDescription

      @Nullable public String getDescription()
      Get description
      Returns:
      description
    • setDescription

      public void setDescription(@Nullable String description)
    • equals

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