com.tencentcloudapi.billing.v20180709.models

Class DescribeVoucherInfoRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.billing.v20180709.models.DescribeVoucherInfoRequest

public class DescribeVoucherInfoRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeVoucherInfoRequest()
DescribeVoucherInfoRequest(DescribeVoucherInfoRequest 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	getActivityId() Get The campaign ID.
String	getCodeId() Get The voucher order ID.
Long	getLimit() Get The number of records per page.
Long	getOffset() Get The page number the records start from.
String	getOperator() Get The operator.
String	getPayMode() Get The payment mode.
String	getPayScene() Get If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go).
String	getProductCode() Get The product code.
String	getSortField() Get The field used to sort the records.
String	getSortOrder() Get Whether to sort the records in ascending or descending order.
String	getStatus() Get The voucher status.
String	getTimeFrom() Get The start date of the voucher issuance, such as `2021-01-01`.
String	getTimeTo() Get The end date of the voucher issuance, such as `2021-01-01`.
String	getVoucherId() Get The voucher ID.
String	getVoucherMainType() Get The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.
String	getVoucherName() Get The voucher name.
String	getVoucherSubType() Get Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.
void	setActivityId(String ActivityId) Set The campaign ID.
void	setCodeId(String CodeId) Set The voucher order ID.
void	setLimit(Long Limit) Set The number of records per page.
void	setOffset(Long Offset) Set The page number the records start from.
void	setOperator(String Operator) Set The operator.
void	setPayMode(String PayMode) Set The payment mode.
void	setPayScene(String PayScene) Set If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go).
void	setProductCode(String ProductCode) Set The product code.
void	setSortField(String SortField) Set The field used to sort the records.
void	setSortOrder(String SortOrder) Set Whether to sort the records in ascending or descending order.
void	setStatus(String Status) Set The voucher status.
void	setTimeFrom(String TimeFrom) Set The start date of the voucher issuance, such as `2021-01-01`.
void	setTimeTo(String TimeTo) Set The end date of the voucher issuance, such as `2021-01-01`.
void	setVoucherId(String VoucherId) Set The voucher ID.
void	setVoucherMainType(String VoucherMainType) Set The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.
void	setVoucherName(String VoucherName) Set The voucher name.
void	setVoucherSubType(String VoucherSubType) Set Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.
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

DescribeVoucherInfoRequest

public DescribeVoucherInfoRequest()

DescribeVoucherInfoRequest

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

getLimit

public Long getLimit()

Get The number of records per page. The default is 20, and the maximum is 1,000.

Returns:

Limit The number of records per page. The default is 20, and the maximum is 1,000.

setLimit

public void setLimit(Long Limit)

Set The number of records per page. The default is 20, and the maximum is 1,000.

Parameters:

Limit - The number of records per page. The default is 20, and the maximum is 1,000.

getOffset

public Long getOffset()

Get The page number the records start from. The default is 1.

Returns:

Offset The page number the records start from. The default is 1.

setOffset

public void setOffset(Long Offset)

Set The page number the records start from. The default is 1.

Parameters:

Offset - The page number the records start from. The default is 1.

getStatus

public String getStatus()

Get The voucher status. Valid values: `unUsed`, `used`, `delivered`, `cancel`, `overdue`.

Returns:

Status The voucher status. Valid values: `unUsed`, `used`, `delivered`, `cancel`, `overdue`.

setStatus

public void setStatus(String Status)

Set The voucher status. Valid values: `unUsed`, `used`, `delivered`, `cancel`, `overdue`.

Parameters:

Status - The voucher status. Valid values: `unUsed`, `used`, `delivered`, `cancel`, `overdue`.

getVoucherId

public String getVoucherId()

Get The voucher ID.

Returns:

VoucherId The voucher ID.

setVoucherId

public void setVoucherId(String VoucherId)

Set The voucher ID.

Parameters:

VoucherId - The voucher ID.

getCodeId

public String getCodeId()

Get The voucher order ID.

Returns:

CodeId The voucher order ID.

setCodeId

public void setCodeId(String CodeId)

Set The voucher order ID.

Parameters:

CodeId - The voucher order ID.

getProductCode

public String getProductCode()

Get The product code.

Returns:

ProductCode The product code.

setProductCode

public void setProductCode(String ProductCode)

Set The product code.

Parameters:

ProductCode - The product code.

getActivityId

public String getActivityId()

Get The campaign ID.

Returns:

ActivityId The campaign ID.

setActivityId

public void setActivityId(String ActivityId)

Set The campaign ID.

Parameters:

ActivityId - The campaign ID.

getVoucherName

public String getVoucherName()

Get The voucher name.

Returns:

VoucherName The voucher name.

setVoucherName

public void setVoucherName(String VoucherName)

Set The voucher name.

Parameters:

VoucherName - The voucher name.

getTimeFrom

public String getTimeFrom()

Get The start date of the voucher issuance, such as `2021-01-01`.

Returns:

TimeFrom The start date of the voucher issuance, such as `2021-01-01`.

setTimeFrom

public void setTimeFrom(String TimeFrom)

Set The start date of the voucher issuance, such as `2021-01-01`.

Parameters:

TimeFrom - The start date of the voucher issuance, such as `2021-01-01`.

getTimeTo

public String getTimeTo()

Get The end date of the voucher issuance, such as `2021-01-01`.

Returns:

TimeTo The end date of the voucher issuance, such as `2021-01-01`.

setTimeTo

public void setTimeTo(String TimeTo)

Set The end date of the voucher issuance, such as `2021-01-01`.

Parameters:

TimeTo - The end date of the voucher issuance, such as `2021-01-01`.

getSortField

public String getSortField()

Get The field used to sort the records. Valid values: BeginTime, EndTime, CreateTime.

Returns:

SortField The field used to sort the records. Valid values: BeginTime, EndTime, CreateTime.

setSortField

public void setSortField(String SortField)

Set The field used to sort the records. Valid values: BeginTime, EndTime, CreateTime.

Parameters:

SortField - The field used to sort the records. Valid values: BeginTime, EndTime, CreateTime.

getSortOrder

public String getSortOrder()

Get Whether to sort the records in ascending or descending order. Valid values: desc, asc.

Returns:

SortOrder Whether to sort the records in ascending or descending order. Valid values: desc, asc.

setSortOrder

public void setSortOrder(String SortOrder)

Set Whether to sort the records in ascending or descending order. Valid values: desc, asc.

Parameters:

SortOrder - Whether to sort the records in ascending or descending order. Valid values: desc, asc.

getPayMode

public String getPayMode()

Get The payment mode. Valid values: `postPay`: pay-as-you-go; `prePay`: prepaid; `riPay`: reserved instance; empty or `*`: all. If this parameter is empty or `*`, `productCode` and `subProductCode` must also be empty.

Returns:

PayMode The payment mode. Valid values: `postPay`: pay-as-you-go; `prePay`: prepaid; `riPay`: reserved instance; empty or `*`: all. If this parameter is empty or `*`, `productCode` and `subProductCode` must also be empty.

setPayMode

public void setPayMode(String PayMode)

Set The payment mode. Valid values: `postPay`: pay-as-you-go; `prePay`: prepaid; `riPay`: reserved instance; empty or `*`: all. If this parameter is empty or `*`, `productCode` and `subProductCode` must also be empty.

Parameters:

PayMode - The payment mode. Valid values: `postPay`: pay-as-you-go; `prePay`: prepaid; `riPay`: reserved instance; empty or `*`: all. If this parameter is empty or `*`, `productCode` and `subProductCode` must also be empty.

getPayScene

public String getPayScene()

Get If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go). If `PayMode` is `prePay`, this parameter may be `purchase`, `renew`, or `modify` (downgrade/upgrade). If `PayMode` is `riPay`, this parameter may be `oneOffFee` (prepayment of reserved instance) or `hourlyFee` (hourly billing of reserved instance). `*` means to query vouchers that support all billing scenarios.

Returns:

PayScene If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go). If `PayMode` is `prePay`, this parameter may be `purchase`, `renew`, or `modify` (downgrade/upgrade). If `PayMode` is `riPay`, this parameter may be `oneOffFee` (prepayment of reserved instance) or `hourlyFee` (hourly billing of reserved instance). `*` means to query vouchers that support all billing scenarios.

setPayScene

public void setPayScene(String PayScene)

Set If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go). If `PayMode` is `prePay`, this parameter may be `purchase`, `renew`, or `modify` (downgrade/upgrade). If `PayMode` is `riPay`, this parameter may be `oneOffFee` (prepayment of reserved instance) or `hourlyFee` (hourly billing of reserved instance). `*` means to query vouchers that support all billing scenarios.

Parameters:

PayScene - If `PayMode` is `postPay`, this parameter may be `spotpay` (spot instance) or `settle account` (regular pay-as-you-go). If `PayMode` is `prePay`, this parameter may be `purchase`, `renew`, or `modify` (downgrade/upgrade). If `PayMode` is `riPay`, this parameter may be `oneOffFee` (prepayment of reserved instance) or `hourlyFee` (hourly billing of reserved instance). `*` means to query vouchers that support all billing scenarios.

getOperator

public String getOperator()

Get The operator. The default is the UIN of the current user.

Returns:

Operator The operator. The default is the UIN of the current user.

setOperator

public void setOperator(String Operator)

Set The operator. The default is the UIN of the current user.

Parameters:

Operator - The operator. The default is the UIN of the current user.

getVoucherMainType

public String getVoucherMainType()

Get The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.

Returns:

VoucherMainType The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.

setVoucherMainType

public void setVoucherMainType(String VoucherMainType)

Set The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.

Parameters:

VoucherMainType - The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively.

getVoucherSubType

public String getVoucherSubType()

Get Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.

Returns:

VoucherSubType Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.

setVoucherSubType

public void setVoucherSubType(String VoucherSubType)

Set Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.

Parameters:

VoucherSubType - Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher.

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.