com.tencentcloudapi.lcic.v20220817.models

Class DocumentInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.DocumentInfo

public class DocumentInfo
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DocumentInfo()
DocumentInfo(DocumentInfo 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
String	getCover() Get The thumbnail.
String	getDocumentId() Get The document ID.
String	getDocumentName() Get The document title.
Long	getDocumentSize() Get The document size (bytes).
String	getDocumentType() Get The document type.
String	getDocumentUrl() Get The document’s original URL.
Long	getHeight() Get The height.
String	getOwner() Get The user ID of the document’s owner.
Long	getPages() Get The number of pages.
Long	getPermission() Get The document access type.
Long	getSdkAppId() Get The application ID.
String	getTranscodeInfo() Get The error message for failed transcoding.
Long	getTranscodeProgress() Get The transcoding progress.
String	getTranscodeResult() Get The transcoding result.
Long	getTranscodeState() Get The transcoding status.
Long	getTranscodeType() Get The transcoding type.
Long	getUpdateTime() Get The time (Unix timestamp) when the document was last updated.
Long	getWidth() Get The width.
void	setCover(String Cover) Set The thumbnail.
void	setDocumentId(String DocumentId) Set The document ID.
void	setDocumentName(String DocumentName) Set The document title.
void	setDocumentSize(Long DocumentSize) Set The document size (bytes).
void	setDocumentType(String DocumentType) Set The document type.
void	setDocumentUrl(String DocumentUrl) Set The document’s original URL.
void	setHeight(Long Height) Set The height.
void	setOwner(String Owner) Set The user ID of the document’s owner.
void	setPages(Long Pages) Set The number of pages.
void	setPermission(Long Permission) Set The document access type.
void	setSdkAppId(Long SdkAppId) Set The application ID.
void	setTranscodeInfo(String TranscodeInfo) Set The error message for failed transcoding.
void	setTranscodeProgress(Long TranscodeProgress) Set The transcoding progress.
void	setTranscodeResult(String TranscodeResult) Set The transcoding result.
void	setTranscodeState(Long TranscodeState) Set The transcoding status.
void	setTranscodeType(Long TranscodeType) Set The transcoding type.
void	setUpdateTime(Long UpdateTime) Set The time (Unix timestamp) when the document was last updated.
void	setWidth(Long Width) Set The width.
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

DocumentInfo

public DocumentInfo()

DocumentInfo

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

getDocumentId

public String getDocumentId()

Get The document ID. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DocumentId The document ID. Note: This field may return null, indicating that no valid values can be obtained.

setDocumentId

public void setDocumentId(String DocumentId)

Set The document ID. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DocumentId - The document ID. Note: This field may return null, indicating that no valid values can be obtained.

getDocumentUrl

public String getDocumentUrl()

Get The document’s original URL. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DocumentUrl The document’s original URL. Note: This field may return null, indicating that no valid values can be obtained.

setDocumentUrl

public void setDocumentUrl(String DocumentUrl)

Set The document’s original URL. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DocumentUrl - The document’s original URL. Note: This field may return null, indicating that no valid values can be obtained.

getDocumentName

public String getDocumentName()

Get The document title. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DocumentName The document title. Note: This field may return null, indicating that no valid values can be obtained.

setDocumentName

public void setDocumentName(String DocumentName)

Set The document title. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DocumentName - The document title. Note: This field may return null, indicating that no valid values can be obtained.

getOwner

public String getOwner()

Get The user ID of the document’s owner. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Owner The user ID of the document’s owner. Note: This field may return null, indicating that no valid values can be obtained.

setOwner

public void setOwner(String Owner)

Set The user ID of the document’s owner. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Owner - The user ID of the document’s owner. Note: This field may return null, indicating that no valid values can be obtained.

getSdkAppId

public Long getSdkAppId()

Get The application ID. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

SdkAppId The application ID. Note: This field may return null, indicating that no valid values can be obtained.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set The application ID. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

SdkAppId - The application ID. Note: This field may return null, indicating that no valid values can be obtained.

getPermission

public Long getPermission()

Get The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Permission The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.

setPermission

public void setPermission(Long Permission)

Set The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Permission - The document access type. 0: Private; 1: Public. Note: This field may return null, indicating that no valid values can be obtained.

getTranscodeResult

public String getTranscodeResult()

Get The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TranscodeResult The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.

setTranscodeResult

public void setTranscodeResult(String TranscodeResult)

Set The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TranscodeResult - The transcoding result. If the file is not transcoded, this parameter will be empty. If it is successfully transcoded, this parameter will be the URL of the transcoded file. If transcoding fails, this parameter will indicate the error code. Note: This field may return null, indicating that no valid values can be obtained.

getTranscodeType

public Long getTranscodeType()

Get The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TranscodeType The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.

setTranscodeType

public void setTranscodeType(Long TranscodeType)

Set The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TranscodeType - The transcoding type. Note: This field may return null, indicating that no valid values can be obtained.

getTranscodeProgress

public Long getTranscodeProgress()

Get The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TranscodeProgress The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.

setTranscodeProgress

public void setTranscodeProgress(Long TranscodeProgress)

Set The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TranscodeProgress - The transcoding progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained.

getTranscodeState

public Long getTranscodeState()

Get The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TranscodeState The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.

setTranscodeState

public void setTranscodeState(Long TranscodeState)

Set The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TranscodeState - The transcoding status. 0: The file is not transcoded. 1: The file is being transcoded. 2: Transcoding failed. 3: Transcoding is successful. Note: This field may return null, indicating that no valid values can be obtained.

getTranscodeInfo

public String getTranscodeInfo()

Get The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TranscodeInfo The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.

setTranscodeInfo

public void setTranscodeInfo(String TranscodeInfo)

Set The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TranscodeInfo - The error message for failed transcoding. Note: This field may return null, indicating that no valid values can be obtained.

getDocumentType

public String getDocumentType()

Get The document type. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DocumentType The document type. Note: This field may return null, indicating that no valid values can be obtained.

setDocumentType

public void setDocumentType(String DocumentType)

Set The document type. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DocumentType - The document type. Note: This field may return null, indicating that no valid values can be obtained.

getDocumentSize

public Long getDocumentSize()

Get The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

DocumentSize The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.

setDocumentSize

public void setDocumentSize(Long DocumentSize)

Set The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

DocumentSize - The document size (bytes). Note: This field may return null, indicating that no valid values can be obtained.

getUpdateTime

public Long getUpdateTime()

Get The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

UpdateTime The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.

setUpdateTime

public void setUpdateTime(Long UpdateTime)

Set The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

UpdateTime - The time (Unix timestamp) when the document was last updated. Note: This field may return null, indicating that no valid values can be obtained.

getPages

public Long getPages()

Get The number of pages. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Pages The number of pages. Note: This field may return null, indicating that no valid values can be obtained.

setPages

public void setPages(Long Pages)

Set The number of pages. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Pages - The number of pages. Note: This field may return null, indicating that no valid values can be obtained.

getWidth

public Long getWidth()

Get The width. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Width The width. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

setWidth

public void setWidth(Long Width)

Set The width. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Width - The width. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

getHeight

public Long getHeight()

Get The height. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Height The height. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

setHeight

public void setHeight(Long Height)

Set The height. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Height - The height. This parameter is valid only if static document transcoding is used. Note: This field may return null, indicating that no valid values can be obtained.

getCover

public String getCover()

Get The thumbnail. Only transcoded courseware has thumbnails. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Cover The thumbnail. Only transcoded courseware has thumbnails. Note: This field may return null, indicating that no valid values can be obtained.

setCover

public void setCover(String Cover)

Set The thumbnail. Only transcoded courseware has thumbnails. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Cover - The thumbnail. Only transcoded courseware has thumbnails. Note: This field may return null, indicating that no valid values can be obtained.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel