com.tencentcloudapi.cdn.v20180606.models

Class DescribeOriginDataRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdn.v20180606.models.DescribeOriginDataRequest

public class DescribeOriginDataRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeOriginDataRequest()
DescribeOriginDataRequest(DescribeOriginDataRequest 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 the service region.
Boolean	getDetail() Get The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in.
String[]	getDomains() Get Specifies the list of domain names to query.
String	getEndTime() Get End time of the query, e.g.
String	getInterval() Get Time granularity, which can be: `min`: Return data with 1-minute granularity.
String	getMetric() Get Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code.
Long	getProject() Get Specifies the project ID to be queried.
String	getStartTime() Get Start time of the query, e.g., 2018-09-04 10:40:00.
String	getTimeZone() Get Specifies a time zone to query.
void	setArea(String Area) Set Specifies the service region.
void	setDetail(Boolean Detail) Set The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in.
void	setDomains(String[] Domains) Set Specifies the list of domain names to query.
void	setEndTime(String EndTime) Set End time of the query, e.g.
void	setInterval(String Interval) Set Time granularity, which can be: `min`: Return data with 1-minute granularity.
void	setMetric(String Metric) Set Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code.
void	setProject(Long Project) Set Specifies the project ID to be queried.
void	setStartTime(String StartTime) Set Start time of the query, e.g., 2018-09-04 10:40:00.
void	setTimeZone(String TimeZone) Set Specifies a time zone to query.
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

DescribeOriginDataRequest

public DescribeOriginDataRequest()

DescribeOriginDataRequest

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

getStartTime

public String getStartTime()

Get Start time of the query, e.g., 2018-09-04 10:40:00. The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

Returns:

StartTime Start time of the query, e.g., 2018-09-04 10:40:00. The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

setStartTime

public void setStartTime(String StartTime)

Set Start time of the query, e.g., 2018-09-04 10:40:00. The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

Parameters:

StartTime - Start time of the query, e.g., 2018-09-04 10:40:00. The specified start time will be rounded down based on the granularity parameter `Interval`. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

getEndTime

public String getEndTime()

Get End time of the query, e.g. 2018-09-04 10:40:00. The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

Returns:

EndTime End time of the query, e.g. 2018-09-04 10:40:00. The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

setEndTime

public void setEndTime(String EndTime)

Set End time of the query, e.g. 2018-09-04 10:40:00. The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

Parameters:

EndTime - End time of the query, e.g. 2018-09-04 10:40:00. The specified end time will be rounded down based on the granularity parameter `Interval`. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00. The period between the start time and end time can be up to 90 days.

getMetric

public String getMetric()

Get Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx origin-pull status codes will be returned (in entries) `2xx`: Returns the aggregate list of 2xx origin-pull status codes and the data for origin-pull status codes starting with 2 (in entries) `3xx`: Returns the aggregate list of 3xx origin-pull status codes and the data for origin-pull status codes starting with 3 (in entries) `4xx`: Returns the aggregate list of 4xx origin-pull status codes and the data for origin-pull status codes starting with 4 (in entries) `5xx`: Returns the aggregate list of 5xx origin-pull status codes and the data for origin-pull status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

Returns:

Metric Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx origin-pull status codes will be returned (in entries) `2xx`: Returns the aggregate list of 2xx origin-pull status codes and the data for origin-pull status codes starting with 2 (in entries) `3xx`: Returns the aggregate list of 3xx origin-pull status codes and the data for origin-pull status codes starting with 3 (in entries) `4xx`: Returns the aggregate list of 4xx origin-pull status codes and the data for origin-pull status codes starting with 4 (in entries) `5xx`: Returns the aggregate list of 5xx origin-pull status codes and the data for origin-pull status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

setMetric

public void setMetric(String Metric)

Set Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx origin-pull status codes will be returned (in entries) `2xx`: Returns the aggregate list of 2xx origin-pull status codes and the data for origin-pull status codes starting with 2 (in entries) `3xx`: Returns the aggregate list of 3xx origin-pull status codes and the data for origin-pull status codes starting with 3 (in entries) `4xx`: Returns the aggregate list of 4xx origin-pull status codes and the data for origin-pull status codes starting with 4 (in entries) `5xx`: Returns the aggregate list of 5xx origin-pull status codes and the data for origin-pull status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

Parameters:

Metric - Specifies the metric to query, which can be: `flux`: Origin-pull traffic (in bytes) `bandwidth`: Origin-pull bandwidth (in bps) `request`: Number of origin-pull requests `failRequest`: Number of failed origin-pull requests `failRate`: Origin-pull failure rate (in %) `statusCode`: Origin-pull status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx origin-pull status codes will be returned (in entries) `2xx`: Returns the aggregate list of 2xx origin-pull status codes and the data for origin-pull status codes starting with 2 (in entries) `3xx`: Returns the aggregate list of 3xx origin-pull status codes and the data for origin-pull status codes starting with 3 (in entries) `4xx`: Returns the aggregate list of 4xx origin-pull status codes and the data for origin-pull status codes starting with 4 (in entries) `5xx`: Returns the aggregate list of 5xx origin-pull status codes and the data for origin-pull status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated.

getDomains

public String[] getDomains()

Get Specifies the list of domain names to query. You can query up to 30 domain names at a time.

Returns:

Domains Specifies the list of domain names to query. You can query up to 30 domain names at a time.

setDomains

public void setDomains(String[] Domains)

Set Specifies the list of domain names to query. You can query up to 30 domain names at a time.

Parameters:

Domains - Specifies the list of domain names to query. You can query up to 30 domain names at a time.

getProject

public Long getProject()

Get Specifies the project ID to be queried. [Check project ID in the console](https://console.cloud.tencent.com/project) If the domain name is not specified, the specified project will be queried. Up to 30 acceleration domain names can be queried at a time. If the domain name information is specified, this parameter can be ignored.

Returns:

Project Specifies the project ID to be queried. [Check project ID in the console](https://console.cloud.tencent.com/project) If the domain name is not specified, the specified project will be queried. Up to 30 acceleration domain names can be queried at a time. If the domain name information is specified, this parameter can be ignored.

setProject

public void setProject(Long Project)

Set Specifies the project ID to be queried. [Check project ID in the console](https://console.cloud.tencent.com/project) If the domain name is not specified, the specified project will be queried. Up to 30 acceleration domain names can be queried at a time. If the domain name information is specified, this parameter can be ignored.

Parameters:

Project - Specifies the project ID to be queried. [Check project ID in the console](https://console.cloud.tencent.com/project) If the domain name is not specified, the specified project will be queried. Up to 30 acceleration domain names can be queried at a time. If the domain name information is specified, this parameter can be ignored.

getInterval

public String getInterval()

Get Time granularity, which can be: `min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`. `5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days. `hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days. `day`: Return data with 1-day granularity. It’s available when the query period is longer than 31 days.

Returns:

Interval Time granularity, which can be: `min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`. `5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days. `hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days. `day`: Return data with 1-day granularity. It’s available when the query period is longer than 31 days.

setInterval

public void setInterval(String Interval)

Set Time granularity, which can be: `min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`. `5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days. `hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days. `day`: Return data with 1-day granularity. It’s available when the query period is longer than 31 days.

Parameters:

Interval - Time granularity, which can be: `min`: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and `Area` is `mainland`. `5min`: Return data with 5-minute granularity. It’s available when the query period is within 31 days. `hour`: Return data with 1-hour granularity. It’s available when the query period is within 31 days. `day`: Return data with 1-day granularity. It’s available when the query period is longer than 31 days.

getDetail

public Boolean getDetail()

Get The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

Returns:

Detail The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

setDetail

public void setDetail(Boolean Detail)

Set The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

Parameters:

Detail - The aggregate data for multiple domain names is returned by default (false) when multiple `Domains` are passed in. You can set it to true to return the details for each Domain (the statusCode metric is currently not supported)

getArea

public String getArea()

Get Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland.

Returns:

Area Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland.

setArea

public void setArea(String Area)

Set Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland.

Parameters:

Area - Specifies the service region. If this value is left blank, it means to query CDN data within the Chinese mainland. `mainland`: Query CDN data in the Chinese mainland. `overseas`: Query CDN data outside the Chinese mainland.

getTimeZone

public String getTimeZone()

Get Specifies a time zone to query. The default time zone is UTC+08:00.

Returns:

TimeZone Specifies a time zone to query. The default time zone is UTC+08:00.

setTimeZone

public void setTimeZone(String TimeZone)

Set Specifies a time zone to query. The default time zone is UTC+08:00.

Parameters:

TimeZone - Specifies a time zone to query. The default time zone is UTC+08:00.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel