com.tencentcloudapi.cdn.v20180606.models

Class DescribePurgeTasksRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.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	getArea() Get Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global
String	getEndTime() Get Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59
String	getKeyword() Get You can filter the results by domain name or a complete URL beginning with `http(s)://`
Long	getLimit() Get Limit on paginated queries.
Long	getOffset() Get Offset for paginated queries.
String	getPurgeType() Get Specifies a purge type: `url`: URL purge record `path`: Directory purge record
String	getStartTime() Get Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`
String	getStatus() Get Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress
String	getTaskId() Get Specifies a task ID when you want to query by task ID.
void	setArea(String Area) Set Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global
void	setEndTime(String EndTime) Set Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59
void	setKeyword(String Keyword) Set You can filter the results by domain name or a complete URL beginning with `http(s)://`
void	setLimit(Long Limit) Set Limit on paginated queries.
void	setOffset(Long Offset) Set Offset for paginated queries.
void	setPurgeType(String PurgeType) Set Specifies a purge type: `url`: URL purge record `path`: Directory purge record
void	setStartTime(String StartTime) Set Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`
void	setStatus(String Status) Set Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress
void	setTaskId(String TaskId) Set Specifies a task ID when you want to query by task 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

getPurgeType

public String getPurgeType()

Get Specifies a purge type: `url`: URL purge record `path`: Directory purge record

Returns:

PurgeType Specifies a purge type: `url`: URL purge record `path`: Directory purge record

setPurgeType

public void setPurgeType(String PurgeType)

Set Specifies a purge type: `url`: URL purge record `path`: Directory purge record

Parameters:

PurgeType - Specifies a purge type: `url`: URL purge record `path`: Directory purge record

getStartTime

public String getStartTime()

Get Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`

Returns:

StartTime Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`

setStartTime

public void setStartTime(String StartTime)

Set Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`

Parameters:

StartTime - Specifies the starting time of the period you want to query, such as `2018-08-08 00:00:00`

getEndTime

public String getEndTime()

Get Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59

Returns:

EndTime Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59

setEndTime

public void setEndTime(String EndTime)

Set Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59

Parameters:

EndTime - Specifies the end time of the period you want to query, such as 2018-08-08 23:59:59

getTaskId

public String getTaskId()

Get Specifies a task ID when you want to query by task ID. You must specify either a task ID or a starting time for your query.

Returns:

TaskId Specifies a task ID when you want to query by task ID. You must specify either a task ID or a starting time for your query.

setTaskId

public void setTaskId(String TaskId)

Set Specifies a task ID when you want to query by task ID. You must specify either a task ID or a starting time for your query.

Parameters:

TaskId - Specifies a task ID when you want to query by task ID. You must specify either a task ID or a starting time for your 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

Returns:

Limit Limit on paginated queries. Default value: 20

setLimit

public void setLimit(Long Limit)

Set Limit on paginated queries. Default value: 20

Parameters:

Limit - Limit on paginated queries. Default value: 20

getKeyword

public String getKeyword()

Get You can filter the results by domain name or a complete URL beginning with `http(s)://`

Returns:

Keyword You can filter the results by domain name or a complete URL beginning with `http(s)://`

setKeyword

public void setKeyword(String Keyword)

Set You can filter the results by domain name or a complete URL beginning with `http(s)://`

Parameters:

Keyword - You can filter the results by domain name or a complete URL beginning with `http(s)://`

getStatus

public String getStatus()

Get Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress

Returns:

Status Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress

setStatus

public void setStatus(String Status)

Set Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress

Parameters:

Status - Specifies a task state for your query: `fail`: purge failed `done`: purge succeeded `process`: purge in progress

getArea

public String getArea()

Get Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global

Returns:

Area Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global

setArea

public void setArea(String Area)

Set Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global

Parameters:

Area - Specifies a purge region for your query: `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global

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.