com.tencentcloudapi.essbasic.v20210526.models.DescribeUsageRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.essbasic.v20210526.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class DescribeUsageRequest extends AbstractModel {
/**
* 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
*/
@SerializedName("StartDate")
@Expose
private String StartDate;
/**
* 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
*/
@SerializedName("EndDate")
@Expose
private String EndDate;
/**
* 是否汇总数据，默认不汇总。
- **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加
- **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)
*/
@SerializedName("NeedAggregate")
@Expose
private Boolean NeedAggregate;
/**
* 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 暂未开放
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
* @return Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
* @param Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
* @return StartDate 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
*/
public String getStartDate() {
return this.StartDate;
}
/**
* Set 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
* @param StartDate 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
*/
public void setStartDate(String StartDate) {
this.StartDate = StartDate;
}
/**
* Get 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
* @return EndDate 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
*/
public String getEndDate() {
return this.EndDate;
}
/**
* Set 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
* @param EndDate 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
*/
public void setEndDate(String EndDate) {
this.EndDate = EndDate;
}
/**
* Get 是否汇总数据，默认不汇总。
- **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加
- **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)
* @return NeedAggregate 是否汇总数据，默认不汇总。
- **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加
- **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)
*/
public Boolean getNeedAggregate() {
return this.NeedAggregate;
}
/**
* Set 是否汇总数据，默认不汇总。
- **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加
- **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)
* @param NeedAggregate 是否汇总数据，默认不汇总。
- **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加
- **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)
*/
public void setNeedAggregate(Boolean NeedAggregate) {
this.NeedAggregate = NeedAggregate;
}
/**
* Get 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
* @return Limit 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
* @param Limit 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
/**
* Get 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
* @return Offset 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
*/
public Long getOffset() {
return this.Offset;
}
/**
* Set 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
* @param Offset 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* Get 暂未开放
* @return Operator 暂未开放
* @deprecated
*/
@Deprecated
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 暂未开放
* @param Operator 暂未开放
* @deprecated
*/
@Deprecated
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
public DescribeUsageRequest() {
}
/**
* 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.
*/
public DescribeUsageRequest(DescribeUsageRequest source) {
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.StartDate != null) {
this.StartDate = new String(source.StartDate);
}
if (source.EndDate != null) {
this.EndDate = new String(source.EndDate);
}
if (source.NeedAggregate != null) {
this.NeedAggregate = new Boolean(source.NeedAggregate);
}
if (source.Limit != null) {
this.Limit = new Long(source.Limit);
}
if (source.Offset != null) {
this.Offset = new Long(source.Offset);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "StartDate", this.StartDate);
this.setParamSimple(map, prefix + "EndDate", this.EndDate);
this.setParamSimple(map, prefix + "NeedAggregate", this.NeedAggregate);
this.setParamSimple(map, prefix + "Limit", this.Limit);
this.setParamSimple(map, prefix + "Offset", this.Offset);
this.setParamObj(map, prefix + "Operator.", this.Operator);
}
}