com.tencentcloudapi.mps.v20190612.models

Class SampleSnapshotTaskInput

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mps.v20190612.models.SampleSnapshotTaskInput

public class SampleSnapshotTaskInput
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SampleSnapshotTaskInput()
SampleSnapshotTaskInput(SampleSnapshotTaskInput 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

Modifier and Type	Method and Description
Long	getDefinition() Get Sampled screencapturing template ID.
NumberFormat	getObjectNumberFormat() Get Rule of the `{number}` variable in the sampled screenshot output path.
String	getOutputObjectPath() Get Output path of an image file after sampled screenshot taking, which can be a relative or absolute path.
TaskOutputStorage	getOutputStorage() Get Target bucket of a sampled screenshot.
WatermarkInput[]	getWatermarkSet() Get List of up to 10 image or text watermarks.
void	setDefinition(Long Definition) Set Sampled screencapturing template ID.
void	setObjectNumberFormat(NumberFormat ObjectNumberFormat) Set Rule of the `{number}` variable in the sampled screenshot output path.
void	setOutputObjectPath(String OutputObjectPath) Set Output path of an image file after sampled screenshot taking, which can be a relative or absolute path.
void	setOutputStorage(TaskOutputStorage OutputStorage) Set Target bucket of a sampled screenshot.
void	setWatermarkSet(WatermarkInput[] WatermarkSet) Set List of up to 10 image or text watermarks.
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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampleSnapshotTaskInput

public SampleSnapshotTaskInput()

SampleSnapshotTaskInput

public SampleSnapshotTaskInput(SampleSnapshotTaskInput 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

getDefinition

public Long getDefinition()

Get Sampled screencapturing template ID.

Returns:

Definition Sampled screencapturing template ID.

setDefinition

public void setDefinition(Long Definition)

Set Sampled screencapturing template ID.

Parameters:

Definition - Sampled screencapturing template ID.

getWatermarkSet

public WatermarkInput[] getWatermarkSet()

Get List of up to 10 image or text watermarks. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

WatermarkSet List of up to 10 image or text watermarks. Note: This field may return null, indicating that no valid values can be obtained.

setWatermarkSet

public void setWatermarkSet(WatermarkInput[] WatermarkSet)

Set List of up to 10 image or text watermarks. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

WatermarkSet - List of up to 10 image or text watermarks. Note: This field may return null, indicating that no valid values can be obtained.

getOutputStorage

public TaskOutputStorage getOutputStorage()

Get Target bucket of a sampled screenshot. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

OutputStorage Target bucket of a sampled screenshot. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.

setOutputStorage

public void setOutputStorage(TaskOutputStorage OutputStorage)

Set Target bucket of a sampled screenshot. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

OutputStorage - Target bucket of a sampled screenshot. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited. Note: This field may return null, indicating that no valid values can be obtained.

getOutputObjectPath

public String getOutputObjectPath()

Get Output path of an image file after sampled screenshot taking, which can be a relative or absolute path. If you need to define an output path, the path must end with `.{format}`. For variable names, refer to [Filename Variable](https://intl.cloud.tencent.com/document/product/862/37039?from_cn_redirect=1).Relative path example:

Filename_{Variable name}.{format}. Filename.{format}. Absolute path example: /Custom path/Filename_{Variable name}.{format}. If left empty, a relative path is used by default: `{inputName}_sampleSnapshot_{definition}_{number}.{format}`.

Returns:

OutputObjectPath Output path of an image file after sampled screenshot taking, which can be a relative or absolute path. If you need to define an output path, the path must end with `.{format}`. For variable names, refer to [Filename Variable](https://intl.cloud.tencent.com/document/product/862/37039?from_cn_redirect=1).Relative path example:

Filename_{Variable name}.{format}.

Filename.{format}.

Absolute path example:

/Custom path/Filename_{Variable name}.{format}.

If left empty, a relative path is used by default: `{inputName}_sampleSnapshot_{definition}_{number}.{format}`.

setOutputObjectPath

public void setOutputObjectPath(String OutputObjectPath)

Set Output path of an image file after sampled screenshot taking, which can be a relative or absolute path. If you need to define an output path, the path must end with `.{format}`. For variable names, refer to [Filename Variable](https://intl.cloud.tencent.com/document/product/862/37039?from_cn_redirect=1).Relative path example:

Filename_{Variable name}.{format}. Filename.{format}. Absolute path example: /Custom path/Filename_{Variable name}.{format}. If left empty, a relative path is used by default: `{inputName}_sampleSnapshot_{definition}_{number}.{format}`.