com.tencentcloudapi.cdn.v20180606.models

Class CompressionRule

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.CompressionRule

public class CompressionRule
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CompressionRule()
CompressionRule(CompressionRule 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[]	getAlgorithms() Get File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.
Boolean	getCompress() Get true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.
String[]	getFileExtensions() Get Compress based on file suffix.
Long	getMaxLength() Get The maximum file size to trigger compression (in bytes).
Long	getMinLength() Get The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.
String[]	getRulePaths() Get Content for each `CacheType`: For `all`, enter a wildcard `*`.
String	getRuleType() Get Rule types: `all`: Apply to all files.
void	setAlgorithms(String[] Algorithms) Set File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.
void	setCompress(Boolean Compress) Set true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.
void	setFileExtensions(String[] FileExtensions) Set Compress based on file suffix.
void	setMaxLength(Long MaxLength) Set The maximum file size to trigger compression (in bytes).
void	setMinLength(Long MinLength) Set The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.
void	setRulePaths(String[] RulePaths) Set Content for each `CacheType`: For `all`, enter a wildcard `*`.
void	setRuleType(String RuleType) Set Rule types: `all`: Apply to all files.
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, isStream, 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

CompressionRule

public CompressionRule()

CompressionRule

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

getCompress

public Boolean getCompress()

Get true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

Compress true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.

setCompress

public void setCompress(Boolean Compress)

Set true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

Compress - true: must be set as true, enables compression Note: this field may return `null`, indicating that no valid values can be obtained.

getMinLength

public Long getMinLength()

Get The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.

Returns:

MinLength The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.

setMinLength

public void setMinLength(Long MinLength)

Set The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.

Parameters:

MinLength - The minimum file size to trigger compression (in bytes) Note: this field may return `null`, indicating that no valid values can be obtained.

getMaxLength

public Long getMaxLength()

Get The maximum file size to trigger compression (in bytes). The maximum value is 30 MB. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

MaxLength The maximum file size to trigger compression (in bytes). The maximum value is 30 MB. Note: This field may return `null`, indicating that no valid value can be obtained.

setMaxLength

public void setMaxLength(Long MaxLength)

Set The maximum file size to trigger compression (in bytes). The maximum value is 30 MB. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

MaxLength - The maximum file size to trigger compression (in bytes). The maximum value is 30 MB. Note: This field may return `null`, indicating that no valid value can be obtained.

getAlgorithms

public String[] getAlgorithms()

Get File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

Algorithms File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.

setAlgorithms

public void setAlgorithms(String[] Algorithms)

Set File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

Algorithms - File compression algorithm `gzip`: Gzip compression `brotli`: Brotli compression Note: This field may return `null`, indicating that no valid value can be obtained.

getFileExtensions

public String[] getFileExtensions()

Get Compress based on file suffix. File suffixes such as jpg and txt are supported. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

FileExtensions Compress based on file suffix. File suffixes such as jpg and txt are supported. Note: This field may return `null`, indicating that no valid value can be obtained.

setFileExtensions

public void setFileExtensions(String[] FileExtensions)

Set Compress based on file suffix. File suffixes such as jpg and txt are supported. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

FileExtensions - Compress based on file suffix. File suffixes such as jpg and txt are supported. Note: This field may return `null`, indicating that no valid value can be obtained.

getRuleType

public String getRuleType()

Get Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `contentType`: Apply when the `ContentType` is specified. If this field is specified, `FileExtensions` does not take effect. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

RuleType Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `contentType`: Apply when the `ContentType` is specified. If this field is specified, `FileExtensions` does not take effect. Note: This field may return `null`, indicating that no valid value can be obtained.

setRuleType

public void setRuleType(String RuleType)

Set Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `contentType`: Apply when the `ContentType` is specified. If this field is specified, `FileExtensions` does not take effect. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

RuleType - Rule types: `all`: Apply to all files. `file`: Apply to files with the specified suffixes. `directory`: Apply to specified paths. `path`: Apply to specified absolute paths. `contentType`: Apply when the `ContentType` is specified. If this field is specified, `FileExtensions` does not take effect. Note: This field may return `null`, indicating that no valid value can be obtained.

getRulePaths

public String[] getRulePaths()

Get Content for each `CacheType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `contentType`, enter `text/html`. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

RulePaths Content for each `CacheType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `contentType`, enter `text/html`. Note: This field may return `null`, indicating that no valid value can be obtained.

setRulePaths

public void setRulePaths(String[] RulePaths)

Set Content for each `CacheType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `contentType`, enter `text/html`. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

RulePaths - Content for each `CacheType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `contentType`, enter `text/html`. Note: This field may return `null`, indicating that no valid value 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

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.