DescribePurgeTasksRequest (tencentcloud-sdk-java-intl-en 3.0.934 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getEndTime()` Get End time of the query.
`AdvancedFilter[]`	`getFilters()` Get Filtering condition.
`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 ZoneId.
`void`	`setEndTime(String EndTime)` Set End time of the query.
`void`	`setFilters(AdvancedFilter[] Filters)` Set Filtering condition.
`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 ZoneId.
`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
  - 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 ZoneId. The parameter is required.
    
    Returns:
    
    ZoneId ZoneId. The parameter is required.
  - setZoneId
```
public void setZoneId(String ZoneId)
```
    Set ZoneId. The parameter is required.
    
    Parameters:
    
    ZoneId - ZoneId. The parameter is required.
  - 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 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 Filtering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions:
  - job-id Filter based on task ID. job-id format: 1379afjk91u32h. Multiple values are not supported, Fuzzy search is not supported;
  - target Filter based on: target resource information. target format: http://www.qq.com/1.txt or tag1. Multiple values are not supported, Fuzzy search is not supported;
  - domains Filter based on domain name. domains format: www.qq.com, Fuzzy search is not supported;
  - statuses Filter based on task status, Fuzzy search is not supported. Options:
    processing: Processing
    success: Success
    failed: Failure
    timeout: Timeout
  - type Filter based on cleared cache type. Multiple values are not supported, Fuzzy search is not supported. Options:
    purge_url: URL
    purge_prefix: Prefix
    purge_all: All cache content
    purge_host: Hostname
    purge_cache_tag: CacheTag

Returns:: Filters Filtering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions:
job-id Filter based on task ID. job-id format: 1379afjk91u32h. Multiple values are not supported, Fuzzy search is not supported;

target Filter based on: target resource information. target format: http://www.qq.com/1.txt or tag1. Multiple values are not supported, Fuzzy search is not supported;

domains Filter based on domain name. domains format: www.qq.com, Fuzzy search is not supported;

statuses Filter based on task status, Fuzzy search is not supported. Options:
processing: Processing
success: Success
failed: Failure
timeout: Timeout

type Filter based on cleared cache type. Multiple values are not supported, Fuzzy search is not supported. Options:
purge_url: URL
purge_prefix: Prefix
purge_all: All cache content
purge_host: Hostname
purge_cache_tag: CacheTag

setFilters
```
public void setFilters(AdvancedFilter[] Filters)
```
Set Filtering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions:
job-id Filter based on task ID. job-id format: 1379afjk91u32h. Multiple values are not supported, Fuzzy search is not supported;
target Filter based on: target resource information. target format: http://www.qq.com/1.txt or tag1. Multiple values are not supported, Fuzzy search is not supported;
domains Filter based on domain name. domains format: www.qq.com, Fuzzy search is not supported;
statuses Filter based on task status, Fuzzy search is not supported. Options:
processing: Processing
success: Success
failed: Failure
timeout: Timeout
type Filter based on cleared cache type. Multiple values are not supported, Fuzzy search is not supported. Options:
purge_url: URL
purge_prefix: Prefix
purge_all: All cache content
purge_host: Hostname
purge_cache_tag: CacheTag

Class DescribePurgeTasksRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribePurgeTasksRequest

DescribePurgeTasksRequest

Method Detail

getZoneId

setZoneId

getStartTime

setStartTime

getEndTime

setEndTime

getOffset

setOffset

getLimit

setLimit

getFilters

setFilters

toMap