com.tencentcloudapi.mps.v20190612.models.ProcessMediaRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.mps.v20190612.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class ProcessMediaRequest extends AbstractModel {
/**
* The information of the file to process.
*/
@SerializedName("InputInfo")
@Expose
private MediaInputInfo InputInfo;
/**
* The storage location of the media processing output file. If this parameter is left empty, the storage location in `InputInfo` will be inherited.
*/
@SerializedName("OutputStorage")
@Expose
private TaskOutputStorage OutputStorage;
/**
* The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`.
If you do not specify this parameter, the file will be saved to the directory specified in `InputInfo`.
*/
@SerializedName("OutputDir")
@Expose
private String OutputDir;
/**
* The scheme ID.
Note 1: About `OutputStorage` and `OutputDir`
If an output storage and directory are specified for a subtask of the scheme, those output settings will be applied.
If an output storage and directory are not specified for the subtasks of a scheme, the output parameters passed in the `ProcessMedia` API will be applied.
Note 2: If `TaskNotifyConfig` is specified, the specified settings will be used instead of the default callback settings of the scheme.
Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme.
*/
@SerializedName("ScheduleId")
@Expose
private Long ScheduleId;
/**
* The media processing parameters to use.
*/
@SerializedName("MediaProcessTask")
@Expose
private MediaProcessTaskInput MediaProcessTask;
/**
* Type parameter of a video content audit task.
*/
@SerializedName("AiContentReviewTask")
@Expose
private AiContentReviewTaskInput AiContentReviewTask;
/**
* Video content analysis task parameter.
*/
@SerializedName("AiAnalysisTask")
@Expose
private AiAnalysisTaskInput AiAnalysisTask;
/**
* Type parameter of a video content recognition task.
*/
@SerializedName("AiRecognitionTask")
@Expose
private AiRecognitionTaskInput AiRecognitionTask;
/**
* The parameters of a quality control task.
*/
@SerializedName("AiQualityControlTask")
@Expose
private AiQualityControlTaskInput AiQualityControlTask;
/**
* Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.
*/
@SerializedName("TaskNotifyConfig")
@Expose
private TaskNotifyConfig TaskNotifyConfig;
/**
* Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
*/
@SerializedName("TasksPriority")
@Expose
private Long TasksPriority;
/**
* The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
*/
@SerializedName("SessionId")
@Expose
private String SessionId;
/**
* The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
*/
@SerializedName("SessionContext")
@Expose
private String SessionContext;
/**
* The task type.
`Online` (default): A task that is executed immediately.
`Offline`: A task that is executed when the system is idle (within three days by default).
*/
@SerializedName("TaskType")
@Expose
private String TaskType;
/**
* Get The information of the file to process.
* @return InputInfo The information of the file to process.
*/
public MediaInputInfo getInputInfo() {
return this.InputInfo;
}
/**
* Set The information of the file to process.
* @param InputInfo The information of the file to process.
*/
public void setInputInfo(MediaInputInfo InputInfo) {
this.InputInfo = InputInfo;
}
/**
* Get The storage location of the media processing output file. If this parameter is left empty, the storage location in `InputInfo` will be inherited.
* @return OutputStorage The storage location of the media processing output file. If this parameter is left empty, the storage location in `InputInfo` will be inherited.
*/
public TaskOutputStorage getOutputStorage() {
return this.OutputStorage;
}
/**
* Set The storage location of the media processing output file. If this parameter is left empty, the storage location in `InputInfo` will be inherited.
* @param OutputStorage The storage location of the media processing output file. If this parameter is left empty, the storage location in `InputInfo` will be inherited.
*/
public void setOutputStorage(TaskOutputStorage OutputStorage) {
this.OutputStorage = OutputStorage;
}
/**
* Get The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`.
If you do not specify this parameter, the file will be saved to the directory specified in `InputInfo`.
* @return OutputDir The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`.
If you do not specify this parameter, the file will be saved to the directory specified in `InputInfo`.
*/
public String getOutputDir() {
return this.OutputDir;
}
/**
* Set The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`.
If you do not specify this parameter, the file will be saved to the directory specified in `InputInfo`.
* @param OutputDir The directory to save the media processing output file, which must start and end with `/`, such as `/movie/201907/`.
If you do not specify this parameter, the file will be saved to the directory specified in `InputInfo`.
*/
public void setOutputDir(String OutputDir) {
this.OutputDir = OutputDir;
}
/**
* Get The scheme ID.
Note 1: About `OutputStorage` and `OutputDir`
If an output storage and directory are specified for a subtask of the scheme, those output settings will be applied.
If an output storage and directory are not specified for the subtasks of a scheme, the output parameters passed in the `ProcessMedia` API will be applied.
Note 2: If `TaskNotifyConfig` is specified, the specified settings will be used instead of the default callback settings of the scheme.
Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme.
* @return ScheduleId The scheme ID.
Note 1: About `OutputStorage` and `OutputDir`
If an output storage and directory are specified for a subtask of the scheme, those output settings will be applied.
If an output storage and directory are not specified for the subtasks of a scheme, the output parameters passed in the `ProcessMedia` API will be applied.
Note 2: If `TaskNotifyConfig` is specified, the specified settings will be used instead of the default callback settings of the scheme.
Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme.
*/
public Long getScheduleId() {
return this.ScheduleId;
}
/**
* Set The scheme ID.
Note 1: About `OutputStorage` and `OutputDir`
If an output storage and directory are specified for a subtask of the scheme, those output settings will be applied.
If an output storage and directory are not specified for the subtasks of a scheme, the output parameters passed in the `ProcessMedia` API will be applied.
Note 2: If `TaskNotifyConfig` is specified, the specified settings will be used instead of the default callback settings of the scheme.
Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme.
* @param ScheduleId The scheme ID.
Note 1: About `OutputStorage` and `OutputDir`
If an output storage and directory are specified for a subtask of the scheme, those output settings will be applied.
If an output storage and directory are not specified for the subtasks of a scheme, the output parameters passed in the `ProcessMedia` API will be applied.
Note 2: If `TaskNotifyConfig` is specified, the specified settings will be used instead of the default callback settings of the scheme.
Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme.
*/
public void setScheduleId(Long ScheduleId) {
this.ScheduleId = ScheduleId;
}
/**
* Get The media processing parameters to use.
* @return MediaProcessTask The media processing parameters to use.
*/
public MediaProcessTaskInput getMediaProcessTask() {
return this.MediaProcessTask;
}
/**
* Set The media processing parameters to use.
* @param MediaProcessTask The media processing parameters to use.
*/
public void setMediaProcessTask(MediaProcessTaskInput MediaProcessTask) {
this.MediaProcessTask = MediaProcessTask;
}
/**
* Get Type parameter of a video content audit task.
* @return AiContentReviewTask Type parameter of a video content audit task.
*/
public AiContentReviewTaskInput getAiContentReviewTask() {
return this.AiContentReviewTask;
}
/**
* Set Type parameter of a video content audit task.
* @param AiContentReviewTask Type parameter of a video content audit task.
*/
public void setAiContentReviewTask(AiContentReviewTaskInput AiContentReviewTask) {
this.AiContentReviewTask = AiContentReviewTask;
}
/**
* Get Video content analysis task parameter.
* @return AiAnalysisTask Video content analysis task parameter.
*/
public AiAnalysisTaskInput getAiAnalysisTask() {
return this.AiAnalysisTask;
}
/**
* Set Video content analysis task parameter.
* @param AiAnalysisTask Video content analysis task parameter.
*/
public void setAiAnalysisTask(AiAnalysisTaskInput AiAnalysisTask) {
this.AiAnalysisTask = AiAnalysisTask;
}
/**
* Get Type parameter of a video content recognition task.
* @return AiRecognitionTask Type parameter of a video content recognition task.
*/
public AiRecognitionTaskInput getAiRecognitionTask() {
return this.AiRecognitionTask;
}
/**
* Set Type parameter of a video content recognition task.
* @param AiRecognitionTask Type parameter of a video content recognition task.
*/
public void setAiRecognitionTask(AiRecognitionTaskInput AiRecognitionTask) {
this.AiRecognitionTask = AiRecognitionTask;
}
/**
* Get The parameters of a quality control task.
* @return AiQualityControlTask The parameters of a quality control task.
*/
public AiQualityControlTaskInput getAiQualityControlTask() {
return this.AiQualityControlTask;
}
/**
* Set The parameters of a quality control task.
* @param AiQualityControlTask The parameters of a quality control task.
*/
public void setAiQualityControlTask(AiQualityControlTaskInput AiQualityControlTask) {
this.AiQualityControlTask = AiQualityControlTask;
}
/**
* Get Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.
* @return TaskNotifyConfig Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.
*/
public TaskNotifyConfig getTaskNotifyConfig() {
return this.TaskNotifyConfig;
}
/**
* Set Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.
* @param TaskNotifyConfig Event notification information of a task. If this parameter is left empty, no event notifications will be obtained.
*/
public void setTaskNotifyConfig(TaskNotifyConfig TaskNotifyConfig) {
this.TaskNotifyConfig = TaskNotifyConfig;
}
/**
* Get Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
* @return TasksPriority Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
*/
public Long getTasksPriority() {
return this.TasksPriority;
}
/**
* Set Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
* @param TasksPriority Task flow priority. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used.
*/
public void setTasksPriority(Long TasksPriority) {
this.TasksPriority = TasksPriority;
}
/**
* Get The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
* @return SessionId The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
*/
public String getSessionId() {
return this.SessionId;
}
/**
* Set The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
* @param SessionId The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed.
*/
public void setSessionId(String SessionId) {
this.SessionId = SessionId;
}
/**
* Get The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
* @return SessionContext The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
*/
public String getSessionContext() {
return this.SessionContext;
}
/**
* Set The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
* @param SessionContext The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
*/
public void setSessionContext(String SessionContext) {
this.SessionContext = SessionContext;
}
/**
* Get The task type.
`Online` (default): A task that is executed immediately.
`Offline`: A task that is executed when the system is idle (within three days by default).
* @return TaskType The task type.
`Online` (default): A task that is executed immediately.
`Offline`: A task that is executed when the system is idle (within three days by default).
*/
public String getTaskType() {
return this.TaskType;
}
/**
* Set The task type.
`Online` (default): A task that is executed immediately.
`Offline`: A task that is executed when the system is idle (within three days by default).
* @param TaskType The task type.
`Online` (default): A task that is executed immediately.
`Offline`: A task that is executed when the system is idle (within three days by default).
*/
public void setTaskType(String TaskType) {
this.TaskType = TaskType;
}
public ProcessMediaRequest() {
}
/**
* 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.
*/
public ProcessMediaRequest(ProcessMediaRequest source) {
if (source.InputInfo != null) {
this.InputInfo = new MediaInputInfo(source.InputInfo);
}
if (source.OutputStorage != null) {
this.OutputStorage = new TaskOutputStorage(source.OutputStorage);
}
if (source.OutputDir != null) {
this.OutputDir = new String(source.OutputDir);
}
if (source.ScheduleId != null) {
this.ScheduleId = new Long(source.ScheduleId);
}
if (source.MediaProcessTask != null) {
this.MediaProcessTask = new MediaProcessTaskInput(source.MediaProcessTask);
}
if (source.AiContentReviewTask != null) {
this.AiContentReviewTask = new AiContentReviewTaskInput(source.AiContentReviewTask);
}
if (source.AiAnalysisTask != null) {
this.AiAnalysisTask = new AiAnalysisTaskInput(source.AiAnalysisTask);
}
if (source.AiRecognitionTask != null) {
this.AiRecognitionTask = new AiRecognitionTaskInput(source.AiRecognitionTask);
}
if (source.AiQualityControlTask != null) {
this.AiQualityControlTask = new AiQualityControlTaskInput(source.AiQualityControlTask);
}
if (source.TaskNotifyConfig != null) {
this.TaskNotifyConfig = new TaskNotifyConfig(source.TaskNotifyConfig);
}
if (source.TasksPriority != null) {
this.TasksPriority = new Long(source.TasksPriority);
}
if (source.SessionId != null) {
this.SessionId = new String(source.SessionId);
}
if (source.SessionContext != null) {
this.SessionContext = new String(source.SessionContext);
}
if (source.TaskType != null) {
this.TaskType = new String(source.TaskType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "InputInfo.", this.InputInfo);
this.setParamObj(map, prefix + "OutputStorage.", this.OutputStorage);
this.setParamSimple(map, prefix + "OutputDir", this.OutputDir);
this.setParamSimple(map, prefix + "ScheduleId", this.ScheduleId);
this.setParamObj(map, prefix + "MediaProcessTask.", this.MediaProcessTask);
this.setParamObj(map, prefix + "AiContentReviewTask.", this.AiContentReviewTask);
this.setParamObj(map, prefix + "AiAnalysisTask.", this.AiAnalysisTask);
this.setParamObj(map, prefix + "AiRecognitionTask.", this.AiRecognitionTask);
this.setParamObj(map, prefix + "AiQualityControlTask.", this.AiQualityControlTask);
this.setParamObj(map, prefix + "TaskNotifyConfig.", this.TaskNotifyConfig);
this.setParamSimple(map, prefix + "TasksPriority", this.TasksPriority);
this.setParamSimple(map, prefix + "SessionId", this.SessionId);
this.setParamSimple(map, prefix + "SessionContext", this.SessionContext);
this.setParamSimple(map, prefix + "TaskType", this.TaskType);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy