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

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 Limit on paginated queries.
Long	getOffset() Get Offset for paginated queries.
String	getStartTime() Get Start time of the query.
String	getZoneId() Get Disused.
void	setEndTime(String EndTime) Set End time of the query.
void	setFilters(AdvancedFilter[] Filters) Set Filter criteria.
void	setLimit(Long Limit) Set Limit on paginated queries.
void	setOffset(Long Offset) Set Offset for paginated queries.
void	setStartTime(String StartTime) Set Start time of the query.
void	setZoneId(String ZoneId) Set Disused.
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

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 Disused. Use "zone-id" in "Filters" instead.

Returns:

ZoneId Disused. Use "zone-id" in "Filters" instead.

setZoneId

public void setZoneId(String ZoneId)

Set Disused. Use "zone-id" in "Filters" instead.

Parameters:

ZoneId - Disused. Use "zone-id" in "Filters" instead.

getStartTime

public String getStartTime()

Get Start time of the query.

Returns:

StartTime Start time of the query.

setStartTime

public void setStartTime(String StartTime)

Set Start time of the query.

Parameters:

StartTime - Start time of the query.

getEndTime

public String getEndTime()

Get End time of the query.

Returns:

EndTime End time of the query.

setEndTime

public void setEndTime(String EndTime)

Set End time of the query.

Parameters:

EndTime - End time of the query.

getOffset

public Long getOffset()

Get Offset for paginated queries. Default value: `0`.

Returns:

Offset Offset for paginated queries. Default value: `0`.

setOffset

public void setOffset(Long Offset)

Set Offset for paginated queries. Default value: `0`.

Parameters:

Offset - Offset for paginated queries. Default value: `0`.

getLimit

public Long getLimit()

Get Limit on paginated queries. Default value: `20`. Maximum value: `1000`.

Returns:

Limit Limit on paginated queries. Default value: `20`. Maximum value: `1000`.

setLimit

public void setLimit(Long Limit)

Set Limit on paginated queries. Default value: `20`. Maximum value: `1000`.

Parameters:

Limit - Limit on paginated queries. Default value: `20`. Maximum value: `1000`.

getFilters

public AdvancedFilter[] getFilters()

Get Filter criteria. Each filter criteria can have up to 20 entries.

`zone-id`:
Filter by site ID, such as zone-xxx (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported`job-id`:
Filter by task ID, such as 1379afjk91u32h (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported`target`:
Filter by target resource, such as http://www.qq.com/1.txt and tag1
Type: String
Required: No
Fuzzy query: Not supported`domains`:
Filter by domain name, such as www.qq.com
Type: String
Required: No
Fuzzy query: Not supported`statuses`:
Filter by task status
Required: No
Fuzzy query: Not supported
Values:
`processing`: The task is in progress.
`success`: The task succeeded.
`failed`: The task failed.
`timeout`: The task timed out.`type`:
Filter by purging mode (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported
Values:
`purge_url`: Purge by URL.
`purge_prefix`: Purge by prefix.
`purge_all`: Purge all caches.
`purge_host`: Purge by hostname.
`purge_cache_tag`: Purge by cache tag.

Returns:

Filters Filter criteria. Each filter criteria can have up to 20 entries.

`zone-id`:
Filter by site ID, such as zone-xxx (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported

`job-id`:
Filter by task ID, such as 1379afjk91u32h (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported

`target`:
Filter by target resource, such as http://www.qq.com/1.txt and tag1
Type: String
Required: No
Fuzzy query: Not supported

`domains`:
Filter by domain name, such as www.qq.com
Type: String
Required: No
Fuzzy query: Not supported

`statuses`:
Filter by task status
Required: No
Fuzzy query: Not supported
Values:
`processing`: The task is in progress.
`success`: The task succeeded.
`failed`: The task failed.
`timeout`: The task timed out.

`type`:
Filter by purging mode (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported
Values:
`purge_url`: Purge by URL.
`purge_prefix`: Purge by prefix.
`purge_all`: Purge all caches.
`purge_host`: Purge by hostname.
`purge_cache_tag`: Purge by cache tag.

setFilters

public void setFilters(AdvancedFilter[] Filters)

Set Filter criteria. Each filter criteria can have up to 20 entries.

`zone-id`:
Filter by site ID, such as zone-xxx (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported`job-id`:
Filter by task ID, such as 1379afjk91u32h (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported`target`:
Filter by target resource, such as http://www.qq.com/1.txt and tag1
Type: String
Required: No
Fuzzy query: Not supported`domains`:
Filter by domain name, such as www.qq.com
Type: String
Required: No
Fuzzy query: Not supported`statuses`:
Filter by task status
Required: No
Fuzzy query: Not supported
Values:
`processing`: The task is in progress.
`success`: The task succeeded.
`failed`: The task failed.
`timeout`: The task timed out.`type`:
Filter by purging mode (up to one entry)
Type: String
Required: No
Fuzzy query: Not supported
Values:
`purge_url`: Purge by URL.
`purge_prefix`: Purge by prefix.
`purge_all`: Purge all caches.
`purge_host`: Purge by hostname.
`purge_cache_tag`: Purge by cache tag.