CreateLivePullStreamTaskRequest (tencentcloud-sdk-java 3.1.314 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.live.v20180801.models.CreateLivePullStreamTaskRequest

public class CreateLivePullStreamTaskRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`CreateLivePullStreamTaskRequest()`
`CreateLivePullStreamTaskRequest(CreateLivePullStreamTaskRequest source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppName()` Get 推流路径。将拉取过来的流推到该路径。
`String[]`	`getCallbackEvents()` Get 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
`String`	`getCallbackUrl()` Get 自定义回调地址。拉流转推任务相关事件会回调到该地址。
`String`	`getComment()` Get 任务描述，限制 512 字节。
`String`	`getDomainName()` Get 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
`String`	`getEndTime()` Get 结束时间，注意： 1.
`String`	`getExtraCmd()` Get 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
`String`	`getOperator()` Get 任务操作人备注。
`String`	`getPushArgs()` Get 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
`String`	`getSourceType()` Get 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
`String[]`	`getSourceUrls()` Get 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
`String`	`getStartTime()` Get 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
`String`	`getStreamName()` Get 推流名称。将拉取过来的流推到该流名称。
`String`	`getVodLoopTimes()` Get 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
`String`	`getVodRefreshType()` Get 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
`void`	`setAppName(String AppName)` Set 推流路径。将拉取过来的流推到该路径。
`void`	`setCallbackEvents(String[] CallbackEvents)` Set 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
`void`	`setCallbackUrl(String CallbackUrl)` Set 自定义回调地址。拉流转推任务相关事件会回调到该地址。
`void`	`setComment(String Comment)` Set 任务描述，限制 512 字节。
`void`	`setDomainName(String DomainName)` Set 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
`void`	`setEndTime(String EndTime)` Set 结束时间，注意： 1.
`void`	`setExtraCmd(String ExtraCmd)` Set 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
`void`	`setOperator(String Operator)` Set 任务操作人备注。
`void`	`setPushArgs(String PushArgs)` Set 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
`void`	`setSourceType(String SourceType)` Set 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
`void`	`setSourceUrls(String[] SourceUrls)` Set 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
`void`	`setStartTime(String StartTime)` Set 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
`void`	`setStreamName(String StreamName)` Set 推流名称。将拉取过来的流推到该流名称。
`void`	`setVodLoopTimes(String VodLoopTimes)` Set 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
`void`	`setVodRefreshType(String VodRefreshType)` Set 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateLivePullStreamTaskRequest
```
public CreateLivePullStreamTaskRequest()
```
  - CreateLivePullStreamTaskRequest
```
public CreateLivePullStreamTaskRequest(CreateLivePullStreamTaskRequest source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getSourceType
```
public String getSourceType()
```
    Get 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
    
    Returns:
    
    SourceType 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
  - setSourceType
```
public void setSourceType(String SourceType)
```
    Set 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
    
    Parameters:
    
    SourceType - 拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播。
  - getSourceUrls
```
public String[] getSourceUrls()
```
    Get 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
    
    Returns:
    
    SourceUrls 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
  - setSourceUrls
```
public void setSourceUrls(String[] SourceUrls)
```
    Set 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
    
    Parameters:
    
    SourceUrls - 拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。当前支持的文件格式：flv，mp4，hls。当前支持的拉流协议：http，https，rtmp。
  - getDomainName
```
public String getDomainName()
```
    Get 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
    
    Returns:
    
    DomainName 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
  - setDomainName
```
public void setDomainName(String DomainName)
```
    Set 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
    
    Parameters:
    
    DomainName - 推流域名。将拉取过来的流推到该域名。注意：请使用已在云直播配置的推流域名。
  - getAppName
```
public String getAppName()
```
    Get 推流路径。将拉取过来的流推到该路径。
    
    Returns:
    
    AppName 推流路径。将拉取过来的流推到该路径。
  - setAppName
```
public void setAppName(String AppName)
```
    Set 推流路径。将拉取过来的流推到该路径。
    
    Parameters:
    
    AppName - 推流路径。将拉取过来的流推到该路径。
  - getStreamName
```
public String getStreamName()
```
    Get 推流名称。将拉取过来的流推到该流名称。
    
    Returns:
    
    StreamName 推流名称。将拉取过来的流推到该流名称。
  - setStreamName
```
public void setStreamName(String StreamName)
```
    Set 推流名称。将拉取过来的流推到该流名称。
    
    Parameters:
    
    StreamName - 推流名称。将拉取过来的流推到该流名称。
  - getStartTime
```
public String getStartTime()
```
    Get 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
    
    Returns:
    
    StartTime 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
  - setStartTime
```
public void setStartTime(String StartTime)
```
    Set 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
    
    Parameters:
    
    StartTime - 开始时间。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
  - getEndTime
```
public String getEndTime()
```
    Get 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间和开始时间间隔必须小于七天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
    
    Returns:
    
    EndTime 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间和开始时间间隔必须小于七天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
  - setEndTime
```
public void setEndTime(String EndTime)
```
    Set 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间和开始时间间隔必须小于七天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
    
    Parameters:
    
    EndTime - 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间和开始时间间隔必须小于七天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
  - getOperator
```
public String getOperator()
```
    Get 任务操作人备注。
    
    Returns:
    
    Operator 任务操作人备注。
  - setOperator
```
public void setOperator(String Operator)
```
    Set 任务操作人备注。
    
    Parameters:
    
    Operator - 任务操作人备注。
  - getPushArgs
```
public String getPushArgs()
```
    Get 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
    
    Returns:
    
    PushArgs 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
  - setPushArgs
```
public void setPushArgs(String PushArgs)
```
    Set 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
    
    Parameters:
    
    PushArgs - 推流参数。推流时携带自定义参数。示例： bak=1&test=2 。
  - getCallbackEvents
```
public String[] getCallbackEvents()
```
    Get 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
    
    Returns:
    
    CallbackEvents 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
  - setCallbackEvents
```
public void setCallbackEvents(String[] CallbackEvents)
```
    Set 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
    
    Parameters:
    
    CallbackEvents - 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
  - getVodLoopTimes
```
public String getVodLoopTimes()
```
    Get 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
    
    Returns:
    
    VodLoopTimes 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
  - setVodLoopTimes
```
public void setVodLoopTimes(String VodLoopTimes)
```
    Set 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
    
    Parameters:
    
    VodLoopTimes - 点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：该配置仅对拉流源为点播时生效。
  - getVodRefreshType
```
public String getVodRefreshType()
```
    Get 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
    
    Returns:
    
    VodRefreshType 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
  - setVodRefreshType
```
public void setVodRefreshType(String VodRefreshType)
```
    Set 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
    
    Parameters:
    
    VodRefreshType - 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放）注意：该配置生效仅对变更前拉流源为点播时生效。
  - getCallbackUrl
```
public String getCallbackUrl()
```
    Get 自定义回调地址。拉流转推任务相关事件会回调到该地址。
    
    Returns:
    
    CallbackUrl 自定义回调地址。拉流转推任务相关事件会回调到该地址。
  - setCallbackUrl
```
public void setCallbackUrl(String CallbackUrl)
```
    Set 自定义回调地址。拉流转推任务相关事件会回调到该地址。
    
    Parameters:
    
    CallbackUrl - 自定义回调地址。拉流转推任务相关事件会回调到该地址。
  - getExtraCmd
```
public String getExtraCmd()
```
    Get 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
    
    Returns:
    
    ExtraCmd 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
  - setExtraCmd
```
public void setExtraCmd(String ExtraCmd)
```
    Set 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
    
    Parameters:
    
    ExtraCmd - 其他参数。示例: ignore_region 用于忽略传入地域, 内部按负载分配。
  - getComment
```
public String getComment()
```
    Get 任务描述，限制 512 字节。
    
    Returns:
    
    Comment 任务描述，限制 512 字节。
  - setComment
```
public void setComment(String Comment)
```
    Set 任务描述，限制 512 字节。
    
    Parameters:
    
    Comment - 任务描述，限制 512 字节。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class CreateLivePullStreamTaskRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateLivePullStreamTaskRequest

CreateLivePullStreamTaskRequest

Method Detail

getSourceType

setSourceType

getSourceUrls

setSourceUrls

getDomainName

setDomainName

getAppName

setAppName

getStreamName

setStreamName

getStartTime

setStartTime

getEndTime

setEndTime

getOperator

setOperator

getPushArgs

setPushArgs

getCallbackEvents

setCallbackEvents

getVodLoopTimes

setVodLoopTimes

getVodRefreshType

setVodRefreshType

getCallbackUrl

setCallbackUrl

getExtraCmd

setExtraCmd

getComment

setComment

toMap