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

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

All Methods Instance Methods Concrete Methods
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 ID of the site.
`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 ID of the site.
`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 ID of the site.
    
    Returns:
    
    ZoneId ID of the site.
  - setZoneId
```
public void setZoneId(String ZoneId)
```
    Set ID of the site.
    
    Parameters:
    
    ZoneId - ID of the site.
  - 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.
  - `job-id`:
    Filter by the Task ID, such as 1379afjk91u32h. Only one ID can be specified.
    Type: String
    Required: No
    Fuzzy query: Not supported
  - `target`:
    Filter by the resource address, such as http://www.qq.com/1.txt. Only one entry allowed.
    Type: String
    Required: No
    Fuzzy query: Not supported
  - `domains`:
    Filter by the domain name, such as www.qq.com
    Type: String
    Required: No
    Fuzzy query: Not supported
  - `statuses`:
    Filter by the task status
    Required: No
    Fuzzy query: Not supported
    Values:
    `processing`: Tasks in progress
    `success`: Succeeded tasks
    `failed`: Failed tasks
    `timeout`: Timed-out tasks
  - `type`:
    Filter by the purging mode. Only one value allowed.
    Type: String
    Required: No
    Fuzzy query: Not supported
    Values:
    `purge_url`: Purge URLs.
    `purge_prefix`: Purge prefixes.
    `purge_all`: Purge all caches.
    `purge_host`: Purge hostnames.

Returns:: Filters Filter criteria. Each filter criteria can have up to 20 entries.
`job-id`:
Filter by the Task ID, such as 1379afjk91u32h. Only one ID can be specified.
Type: String
Required: No
Fuzzy query: Not supported
`target`:
Filter by the resource address, such as http://www.qq.com/1.txt. Only one entry allowed.
Type: String
Required: No
Fuzzy query: Not supported
`domains`:
Filter by the domain name, such as www.qq.com
Type: String
Required: No
Fuzzy query: Not supported
`statuses`:
Filter by the task status
Required: No
Fuzzy query: Not supported
Values:
`processing`: Tasks in progress
`success`: Succeeded tasks
`failed`: Failed tasks
`timeout`: Timed-out tasks
`type`:
Filter by the purging mode. Only one value allowed.
Type: String
Required: No
Fuzzy query: Not supported
Values:
`purge_url`: Purge URLs.
`purge_prefix`: Purge prefixes.
`purge_all`: Purge all caches.
`purge_host`: Purge hostnames.

setFilters
```
public void setFilters(AdvancedFilter[] Filters)
```
Set Filter criteria. Each filter criteria can have up to 20 entries.
`job-id`:
Filter by the Task ID, such as 1379afjk91u32h. Only one ID can be specified.
Type: String
Required: No
Fuzzy query: Not supported
`target`:
Filter by the resource address, such as http://www.qq.com/1.txt. Only one entry allowed.
Type: String
Required: No
Fuzzy query: Not supported
`domains`:
Filter by the domain name, such as www.qq.com
Type: String
Required: No
Fuzzy query: Not supported
`statuses`:
Filter by the task status
Required: No
Fuzzy query: Not supported
Values:
`processing`: Tasks in progress
`success`: Succeeded tasks
`failed`: Failed tasks
`timeout`: Timed-out tasks
`type`:
Filter by the purging mode. Only one value allowed.
Type: String
Required: No
Fuzzy query: Not supported
Values:
`purge_url`: Purge URLs.
`purge_prefix`: Purge prefixes.
`purge_all`: Purge all caches.
`purge_host`: Purge hostnames.

Class DescribePurgeTasksRequest

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