com.tencentcloudapi.cls.v20201016.models

Class ShipperInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cls.v20201016.models.ShipperInfo

public class ShipperInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ShipperInfo()
ShipperInfo(ShipperInfo 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	getBucket() Get Bucket address shipped to
CompressInfo	getCompress() Get Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.
ContentInfo	getContent() Get Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.
String	getCreateTime() Get Creation time of shipped log
Long	getEndTime() Get End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.
Long	getFilenameMode() Get Shipping file naming configuration.
FilterRuleInfo[]	getFilterRules() Get Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.
Long	getHistoryStatus() Get Status of historical data shipping.
Long	getInterval() Get Shipping time interval in seconds
Long	getMaxSize() Get Maximum size of shipped file in MB
String	getPartition() Get Partition rule of shipped log, which can be represented in `strftime` time format
String	getPrefix() Get Shipping prefix directory
Float	getProgress() Get Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.
Long	getRemainTime() Get Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.
String	getShipperId() Get Shipping rule ID
String	getShipperName() Get Shipping rule name
Long	getStartTime() Get Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.
Boolean	getStatus() Get Whether it takes effect
String	getStorageType() Get COS bucket type Note: This field may return null, indicating that no valid values can be obtained.
String	getTopicId() Get Log topic ID
void	setBucket(String Bucket) Set Bucket address shipped to
void	setCompress(CompressInfo Compress) Set Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.
void	setContent(ContentInfo Content) Set Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.
void	setCreateTime(String CreateTime) Set Creation time of shipped log
void	setEndTime(Long EndTime) Set End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.
void	setFilenameMode(Long FilenameMode) Set Shipping file naming configuration.
void	setFilterRules(FilterRuleInfo[] FilterRules) Set Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.
void	setHistoryStatus(Long HistoryStatus) Set Status of historical data shipping.
void	setInterval(Long Interval) Set Shipping time interval in seconds
void	setMaxSize(Long MaxSize) Set Maximum size of shipped file in MB
void	setPartition(String Partition) Set Partition rule of shipped log, which can be represented in `strftime` time format
void	setPrefix(String Prefix) Set Shipping prefix directory
void	setProgress(Float Progress) Set Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.
void	setRemainTime(Long RemainTime) Set Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.
void	setShipperId(String ShipperId) Set Shipping rule ID
void	setShipperName(String ShipperName) Set Shipping rule name
void	setStartTime(Long StartTime) Set Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.
void	setStatus(Boolean Status) Set Whether it takes effect
void	setStorageType(String StorageType) Set COS bucket type Note: This field may return null, indicating that no valid values can be obtained.
void	setTopicId(String TopicId) Set Log topic ID
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

ShipperInfo

public ShipperInfo()

ShipperInfo

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

getShipperId

public String getShipperId()

Get Shipping rule ID

Returns:

ShipperId Shipping rule ID

setShipperId

public void setShipperId(String ShipperId)

Set Shipping rule ID

Parameters:

ShipperId - Shipping rule ID

getTopicId

public String getTopicId()

Get Log topic ID

Returns:

TopicId Log topic ID

setTopicId

public void setTopicId(String TopicId)

Set Log topic ID

Parameters:

TopicId - Log topic ID

getBucket

public String getBucket()

Get Bucket address shipped to

Returns:

Bucket Bucket address shipped to

setBucket

public void setBucket(String Bucket)

Set Bucket address shipped to

Parameters:

Bucket - Bucket address shipped to

getPrefix

public String getPrefix()

Get Shipping prefix directory

Returns:

Prefix Shipping prefix directory

setPrefix

public void setPrefix(String Prefix)

Set Shipping prefix directory

Parameters:

Prefix - Shipping prefix directory

getShipperName

public String getShipperName()

Get Shipping rule name

Returns:

ShipperName Shipping rule name

setShipperName

public void setShipperName(String ShipperName)

Set Shipping rule name

Parameters:

ShipperName - Shipping rule name

getInterval

public Long getInterval()

Get Shipping time interval in seconds

Returns:

Interval Shipping time interval in seconds

setInterval

public void setInterval(Long Interval)

Set Shipping time interval in seconds

Parameters:

Interval - Shipping time interval in seconds

getMaxSize

public Long getMaxSize()

Get Maximum size of shipped file in MB

Returns:

MaxSize Maximum size of shipped file in MB

setMaxSize

public void setMaxSize(Long MaxSize)

Set Maximum size of shipped file in MB

Parameters:

MaxSize - Maximum size of shipped file in MB

getStatus

public Boolean getStatus()

Get Whether it takes effect

Returns:

Status Whether it takes effect

setStatus

public void setStatus(Boolean Status)

Set Whether it takes effect

Parameters:

Status - Whether it takes effect

getFilterRules

public FilterRuleInfo[] getFilterRules()

Get Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

FilterRules Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

setFilterRules

public void setFilterRules(FilterRuleInfo[] FilterRules)

Set Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

FilterRules - Filter rule for shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

getPartition

public String getPartition()

Get Partition rule of shipped log, which can be represented in `strftime` time format

Returns:

Partition Partition rule of shipped log, which can be represented in `strftime` time format

setPartition

public void setPartition(String Partition)

Set Partition rule of shipped log, which can be represented in `strftime` time format

Parameters:

Partition - Partition rule of shipped log, which can be represented in `strftime` time format

getCompress

public CompressInfo getCompress()

Get Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Compress Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

setCompress

public void setCompress(CompressInfo Compress)

Set Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Compress - Compression configuration of shipped log Note: this field may return `null`, indicating that no valid values can be obtained.

getContent

public ContentInfo getContent()

Get Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Content Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.

setContent

public void setContent(ContentInfo Content)

Set Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Content - Format configuration of shipped log content Note: this field may return `null`, indicating that no valid values can be obtained.

getCreateTime

public String getCreateTime()

Get Creation time of shipped log

Returns:

CreateTime Creation time of shipped log

setCreateTime

public void setCreateTime(String CreateTime)

Set Creation time of shipped log

Parameters:

CreateTime - Creation time of shipped log

getFilenameMode

public Long getFilenameMode()

Get Shipping file naming configuration. Valid values: `0` (by random number); `1` (by shipping time). Default value: `0`. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

FilenameMode Shipping file naming configuration. Valid values: `0` (by random number); `1` (by shipping time). Default value: `0`. Note: This field may return null, indicating that no valid values can be obtained.

setFilenameMode

public void setFilenameMode(Long FilenameMode)

Set Shipping file naming configuration. Valid values: `0` (by random number); `1` (by shipping time). Default value: `0`. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

FilenameMode - Shipping file naming configuration. Valid values: `0` (by random number); `1` (by shipping time). Default value: `0`. Note: This field may return null, indicating that no valid values can be obtained.

getStartTime

public Long getStartTime()

Get Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

Returns:

StartTime Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

setStartTime

public void setStartTime(Long StartTime)

Set Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

StartTime - Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

getEndTime

public Long getEndTime()

Get End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

Returns:

EndTime End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

setEndTime

public void setEndTime(Long EndTime)

Set End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

EndTime - End time for data shipping Note: This field may return null, indicating that no valid values can be obtained.

getProgress

public Float getProgress()

Get Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Progress Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

setProgress

public void setProgress(Float Progress)

Set Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Progress - Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

getRemainTime

public Long getRemainTime()

Get Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

Returns:

RemainTime Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

setRemainTime

public void setRemainTime(Long RemainTime)

Set Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

RemainTime - Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained.

getHistoryStatus

public Long getHistoryStatus()

Get Status of historical data shipping. Valid values: 0: Real-time data is being shipped. 1: The system is preparing for historical data shipping. 2: Historical data is being shipped. 3: An error occurred while shipping historical data. 4: Historical data shipping ended. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

HistoryStatus Status of historical data shipping. Valid values: 0: Real-time data is being shipped. 1: The system is preparing for historical data shipping. 2: Historical data is being shipped. 3: An error occurred while shipping historical data. 4: Historical data shipping ended. Note: This field may return null, indicating that no valid values can be obtained.

setHistoryStatus

public void setHistoryStatus(Long HistoryStatus)

Set Status of historical data shipping. Valid values: 0: Real-time data is being shipped. 1: The system is preparing for historical data shipping. 2: Historical data is being shipped. 3: An error occurred while shipping historical data. 4: Historical data shipping ended. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

HistoryStatus - Status of historical data shipping. Valid values: 0: Real-time data is being shipped. 1: The system is preparing for historical data shipping. 2: Historical data is being shipped. 3: An error occurred while shipping historical data. 4: Historical data shipping ended. Note: This field may return null, indicating that no valid values can be obtained.

getStorageType

public String getStorageType()

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

Returns:

StorageType COS bucket type Note: This field may return null, indicating that no valid values can be obtained.

setStorageType

public void setStorageType(String StorageType)

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

Parameters:

StorageType - COS bucket type 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