com.tencentcloudapi.teo.v20220901.models

Class DescribePurgeTasksRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.teo.v20220901.models.DescribePurgeTasksRequest

public class DescribePurgeTasksRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribePurgeTasksRequest()
DescribePurgeTasksRequest(DescribePurgeTasksRequest 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	getEndTime() Get End time of the query.
AdvancedFilter[]	getFilters() Get Filter criteria.
Long	getLimit() Get Number limit of paginated query.
Long	getOffset() Get Offset of paginated query.
String	getStartTime() Get Start time of the query.
String	getZoneId() Get Site ID.
void	setEndTime(String EndTime) Set End time of the query.
void	setFilters(AdvancedFilter[] Filters) Set Filter criteria.
void	setLimit(Long Limit) Set Number limit of paginated query.
void	setOffset(Long Offset) Set Offset of paginated query.
void	setStartTime(String StartTime) Set Start time of the query.
void	setZoneId(String ZoneId) Set Site 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, 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

DescribePurgeTasksRequest

public DescribePurgeTasksRequest()

DescribePurgeTasksRequest

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

getZoneId

public String getZoneId()

Get Site ID. The parameter will change from optional to mandatory after May 30, 2024.Refer to [Cloud API Change Notification](https://www.tencentcloud.com/document/product/1145/59980)

Returns:

ZoneId Site ID. The parameter will change from optional to mandatory after May 30, 2024.Refer to [Cloud API Change Notification](https://www.tencentcloud.com/document/product/1145/59980)

setZoneId

public void setZoneId(String ZoneId)

Set Site ID. The parameter will change from optional to mandatory after May 30, 2024.Refer to [Cloud API Change Notification](https://www.tencentcloud.com/document/product/1145/59980)

Parameters:

ZoneId - Site ID. The parameter will change from optional to mandatory after May 30, 2024.Refer to [Cloud API Change Notification](https://www.tencentcloud.com/document/product/1145/59980)

getStartTime

public String getStartTime()

Get Start time of the query. Either time or job-id is required.

Returns:

StartTime Start time of the query. Either time or job-id is required.

setStartTime

public void setStartTime(String StartTime)

Set Start time of the query. Either time or job-id is required.

Parameters:

StartTime - Start time of the query. Either time or job-id is required.

getEndTime

public String getEndTime()

Get End time of the query. Either time or job-id is required.

Returns:

EndTime End time of the query. Either time or job-id is required.

setEndTime

public void setEndTime(String EndTime)

Set End time of the query. Either time or job-id is required.

Parameters:

EndTime - End time of the query. Either time or job-id is required.

getOffset

public Long getOffset()

Get Offset of paginated query. Default value: 0.

Returns:

Offset Offset of paginated query. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset of paginated query. Default value: 0.

Parameters:

Offset - Offset of paginated query. Default value: 0.

getLimit

public Long getLimit()

Get Number limit of paginated query. Default value: 20. Maximum value: 1000.

Returns:

Limit Number limit of paginated query. Default value: 20. Maximum value: 1000.

setLimit

public void setLimit(Long Limit)

Set Number limit of paginated query. Default value: 20. Maximum value: 1000.

Parameters:

Limit - Number limit of paginated query. Default value: 20. Maximum value: 1000.

getFilters

public AdvancedFilter[] getFilters()

Get Filter criteria. The maximum number of Filters.Values is 20. The detailed filter criteria are as follows:

job-id: Filter by task ID in the format like 1379afjk91u32h. Multiple values and fuzzy queries are not supported. target: Filter by target resource information in the format like http://www.qq.com/1.txt or tag1. Multiple values are not supported yet. Fuzzy queries are supported. domains: Filter by domain name in the format like www.qq.com. Fuzzy queries are not supported. statuses: Filter by task status. Fuzzy queries are not supported. Options:
processing: processing
success: successful
failed: failed
timeout: timed out
canceled: Canceled type: Filter by cache clearance type. Multiple values and fuzzy queries are not supported yet. Options:
purge_url: URL
purge_prefix: prefix
purge_all: all cached content
purge_host: Hostname
purge_cache_tag: CacheTag

Returns:

Filters Filter criteria. The maximum number of Filters.Values is 20. The detailed filter criteria are as follows:

job-id: Filter by task ID in the format like 1379afjk91u32h. Multiple values and fuzzy queries are not supported.

target: Filter by target resource information in the format like http://www.qq.com/1.txt or tag1. Multiple values are not supported yet. Fuzzy queries are supported.

domains: Filter by domain name in the format like www.qq.com. Fuzzy queries are not supported.

statuses: Filter by task status. Fuzzy queries are not supported. Options:
processing: processing
success: successful
failed: failed
timeout: timed out
canceled: Canceled

type: Filter by cache clearance type. Multiple values and fuzzy queries are not supported yet. Options:
purge_url: URL
purge_prefix: prefix
purge_all: all cached content
purge_host: Hostname
purge_cache_tag: CacheTag

setFilters

public void setFilters(AdvancedFilter[] Filters)

Set Filter criteria. The maximum number of Filters.Values is 20. The detailed filter criteria are as follows:

job-id: Filter by task ID in the format like 1379afjk91u32h. Multiple values and fuzzy queries are not supported. target: Filter by target resource information in the format like http://www.qq.com/1.txt or tag1. Multiple values are not supported yet. Fuzzy queries are supported. domains: Filter by domain name in the format like www.qq.com. Fuzzy queries are not supported. statuses: Filter by task status. Fuzzy queries are not supported. Options:
processing: processing
success: successful
failed: failed
timeout: timed out
canceled: Canceled type: Filter by cache clearance type. Multiple values and fuzzy queries are not supported yet. Options:
purge_url: URL
purge_prefix: prefix
purge_all: all cached content
purge_host: Hostname
purge_cache_tag: CacheTag