Package com.qtsurfer.api.client.model
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumA `public` run appears in `GET /live/public` and its signal channel accepts subscriptions from anyone, not only you. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddSourcesItem(LiveSource sourcesItem) description(String description) booleanReturn true if this StartLiveRequest object is equal to o.Get descriptiongetName()Get nameStrategy parameters to start with.getRelay()Request that this run's signals be relayed over its WebSocket channel once it reaches the `live` stage — see the \"Live execution\" guide.Get sourcesA `public` run appears in `GET /live/public` and its signal channel accepts subscriptions from anyone, not only you.inthashCode()voidsetDescription(String description) voidvoidvoidvoidsetSources(List<LiveSource> sources) voidsetVisibility(StartLiveRequest.VisibilityEnum visibility) sources(List<LiveSource> sources) toString()Convert the instance into URL query string.toUrlQueryString(String prefix) Convert the instance into URL query string.visibility(StartLiveRequest.VisibilityEnum visibility)
-
Field Details
-
JSON_PROPERTY_SOURCES
- See Also:
-
JSON_PROPERTY_PARAMS
- See Also:
-
JSON_PROPERTY_VISIBILITY
- See Also:
-
JSON_PROPERTY_RELAY
- See Also:
-
JSON_PROPERTY_NAME
- See Also:
-
JSON_PROPERTY_DESCRIPTION
- See Also:
-
-
Constructor Details
-
StartLiveRequest
public StartLiveRequest()
-
-
Method Details
-
sources
-
addSourcesItem
-
getSources
Get sources- Returns:
- sources
-
setSources
-
params
-
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
-
visibility
-
getVisibility
A `public` run appears in `GET /live/public` and its signal channel accepts subscriptions from anyone, not only you.- Returns:
- visibility
-
setVisibility
-
relay
-
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
-
name
-
getName
Get name- Returns:
- name
-
setName
-
description
-
getDescription
Get description- Returns:
- description
-
setDescription
-
equals
Return true if this StartLiveRequest object is equal to o. -
hashCode
public int hashCode() -
toString
-
toUrlQueryString
Convert the instance into URL query string.- Returns:
- URL query string
-
toUrlQueryString
Convert the instance into URL query string.- Parameters:
prefix- prefix of the query string- Returns:
- URL query string
-