com.tencentcloudapi.ssl.v20191205.models

Class DescribeCertificatesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ssl.v20191205.models.DescribeCertificatesRequest

public class DescribeCertificatesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeCertificatesRequest()
DescribeCertificatesRequest(DescribeCertificatesRequest 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[]	getCertIds() Get Filter certificates by the specified certificate id, only supports certificate ids with permission.
Long[]	getCertificateStatus() Get Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.
String	getCertificateType() Get Certificate type.
Long	getDeployable() Get Whether the certificate can be deployed.
String	getExpirationSort() Get Default sorting is by certificate application time in descending order.
Long	getFilterExpiring() Get Whether to filter expiring certificates.
String	getFilterSource() Get Filter by source.
Long	getHostable() Get Whether the certificate can be hosted.
Long	getIsPendingIssue() Get Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.
Long	getIsSM() Get Whether to filter Chinese SM certificates.
Long	getLimit() Get Number of items per page.
Long	getOffset() Get Pagination offset, starting from 0.
Long	getProjectId() Get Project ID
Long	getRenew() Get Whether to filter renewable certificates.
String	getSearchKey() Get Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.
Tags[]	getTags() Get Filter certificates with specified tags.
Long	getUpload() Get Whether to filter uploaded hosted certificates.
void	setCertIds(String[] CertIds) Set Filter certificates by the specified certificate id, only supports certificate ids with permission.
void	setCertificateStatus(Long[] CertificateStatus) Set Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.
void	setCertificateType(String CertificateType) Set Certificate type.
void	setDeployable(Long Deployable) Set Whether the certificate can be deployed.
void	setExpirationSort(String ExpirationSort) Set Default sorting is by certificate application time in descending order.
void	setFilterExpiring(Long FilterExpiring) Set Whether to filter expiring certificates.
void	setFilterSource(String FilterSource) Set Filter by source.
void	setHostable(Long Hostable) Set Whether the certificate can be hosted.
void	setIsPendingIssue(Long IsPendingIssue) Set Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.
void	setIsSM(Long IsSM) Set Whether to filter Chinese SM certificates.
void	setLimit(Long Limit) Set Number of items per page.
void	setOffset(Long Offset) Set Pagination offset, starting from 0.
void	setProjectId(Long ProjectId) Set Project ID
void	setRenew(Long Renew) Set Whether to filter renewable certificates.
void	setSearchKey(String SearchKey) Set Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.
void	setTags(Tags[] Tags) Set Filter certificates with specified tags.
void	setUpload(Long Upload) Set Whether to filter uploaded hosted certificates.
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

DescribeCertificatesRequest

public DescribeCertificatesRequest()

DescribeCertificatesRequest

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

getOffset

public Long getOffset()

Get Pagination offset, starting from 0. default is 0.

Returns:

Offset Pagination offset, starting from 0. default is 0.

setOffset

public void setOffset(Long Offset)

Set Pagination offset, starting from 0. default is 0.

Parameters:

Offset - Pagination offset, starting from 0. default is 0.

getLimit

public Long getLimit()

Get Number of items per page. default is 10. maximum value is 1000; values exceeding 1000 will be treated as 1000.

Returns:

Limit Number of items per page. default is 10. maximum value is 1000; values exceeding 1000 will be treated as 1000.

setLimit

public void setLimit(Long Limit)

Set Number of items per page. default is 10. maximum value is 1000; values exceeding 1000 will be treated as 1000.

Parameters:

Limit - Number of items per page. default is 10. maximum value is 1000; values exceeding 1000 will be treated as 1000.

getSearchKey

public String getSearchKey()

Get Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.

Returns:

SearchKey Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.

setSearchKey

public void setSearchKey(String SearchKey)

Set Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.

Parameters:

SearchKey - Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name.

getCertificateType

public String getCertificateType()

Get Certificate type. `CA`: client certificate; `SVR`: server certificate

Returns:

CertificateType Certificate type. `CA`: client certificate; `SVR`: server certificate

setCertificateType

public void setCertificateType(String CertificateType)

Set Certificate type. `CA`: client certificate; `SVR`: server certificate

Parameters:

CertificateType - Certificate type. `CA`: client certificate; `SVR`: server certificate

getProjectId

public Long getProjectId()

Get Project ID

Returns:

ProjectId Project ID

setProjectId

public void setProjectId(Long ProjectId)

Set Project ID

Parameters:

ProjectId - Project ID

getExpirationSort

public String getExpirationSort()

Get Default sorting is by certificate application time in descending order. Sort by expiration date if the following values are passed: DESC for descending order of certificate expiration time, ASC for ascending order.

Returns:

ExpirationSort Default sorting is by certificate application time in descending order. Sort by expiration date if the following values are passed: DESC for descending order of certificate expiration time, ASC for ascending order.

setExpirationSort

public void setExpirationSort(String ExpirationSort)

Set Default sorting is by certificate application time in descending order. Sort by expiration date if the following values are passed: DESC for descending order of certificate expiration time, ASC for ascending order.

Parameters:

ExpirationSort - Default sorting is by certificate application time in descending order. Sort by expiration date if the following values are passed: DESC for descending order of certificate expiration time, ASC for ascending order.

getCertificateStatus

public Long[] getCertificateStatus()

Get Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.

Returns:

CertificateStatus Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.

setCertificateStatus

public void setCertificateStatus(Long[] CertificateStatus)

Set Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.

Parameters:

CertificateStatus - Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress.

getDeployable

public Long getDeployable()

Get Whether the certificate can be deployed. `1`: yes; `0`: no

Returns:

Deployable Whether the certificate can be deployed. `1`: yes; `0`: no

setDeployable

public void setDeployable(Long Deployable)

Set Whether the certificate can be deployed. `1`: yes; `0`: no

Parameters:

Deployable - Whether the certificate can be deployed. `1`: yes; `0`: no

getUpload

public Long getUpload()

Get Whether to filter uploaded hosted certificates. `1`: Yes; `0`: No.

Returns:

Upload Whether to filter uploaded hosted certificates. `1`: Yes; `0`: No.

setUpload

public void setUpload(Long Upload)

Set Whether to filter uploaded hosted certificates. `1`: Yes; `0`: No.

Parameters:

Upload - Whether to filter uploaded hosted certificates. `1`: Yes; `0`: No.

getRenew

public Long getRenew()

Get Whether to filter renewable certificates. `1`: Yes; `0`: No.

Returns:

Renew Whether to filter renewable certificates. `1`: Yes; `0`: No.

setRenew

public void setRenew(Long Renew)

Set Whether to filter renewable certificates. `1`: Yes; `0`: No.

Parameters:

Renew - Whether to filter renewable certificates. `1`: Yes; `0`: No.

getFilterSource

public String getFilterSource()

Get Filter by source. `upload`: Uploaded certificate; `buy`: Tencent Cloud certificate. If this parameter is left empty, all certificates will be queried.

Returns:

FilterSource Filter by source. `upload`: Uploaded certificate; `buy`: Tencent Cloud certificate. If this parameter is left empty, all certificates will be queried.

setFilterSource

public void setFilterSource(String FilterSource)

Set Filter by source. `upload`: Uploaded certificate; `buy`: Tencent Cloud certificate. If this parameter is left empty, all certificates will be queried.

Parameters:

FilterSource - Filter by source. `upload`: Uploaded certificate; `buy`: Tencent Cloud certificate. If this parameter is left empty, all certificates will be queried.

getIsSM

public Long getIsSM()

Get Whether to filter Chinese SM certificates. `1`: Yes; `0`: No.

Returns:

IsSM Whether to filter Chinese SM certificates. `1`: Yes; `0`: No.

setIsSM

public void setIsSM(Long IsSM)

Set Whether to filter Chinese SM certificates. `1`: Yes; `0`: No.

Parameters:

IsSM - Whether to filter Chinese SM certificates. `1`: Yes; `0`: No.

getFilterExpiring

public Long getFilterExpiring()

Get Whether to filter expiring certificates. `1`: Yes; `0`: No.

Returns:

FilterExpiring Whether to filter expiring certificates. `1`: Yes; `0`: No.

setFilterExpiring

public void setFilterExpiring(Long FilterExpiring)

Set Whether to filter expiring certificates. `1`: Yes; `0`: No.

Parameters:

FilterExpiring - Whether to filter expiring certificates. `1`: Yes; `0`: No.

getHostable

public Long getHostable()

Get Whether the certificate can be hosted. Valid values: `1` for yes and `0` for no.

Returns:

Hostable Whether the certificate can be hosted. Valid values: `1` for yes and `0` for no.

setHostable

public void setHostable(Long Hostable)

Set Whether the certificate can be hosted. Valid values: `1` for yes and `0` for no.

Parameters:

Hostable - Whether the certificate can be hosted. Valid values: `1` for yes and `0` for no.

getTags

public Tags[] getTags()

Get Filter certificates with specified tags.

Returns:

Tags Filter certificates with specified tags.

setTags

public void setTags(Tags[] Tags)

Set Filter certificates with specified tags.

Parameters:

Tags - Filter certificates with specified tags.

getIsPendingIssue

public Long getIsPendingIssue()

Get Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.

Returns:

IsPendingIssue Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.

setIsPendingIssue

public void setIsPendingIssue(Long IsPendingIssue)

Set Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.

Parameters:

IsPendingIssue - Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering.

getCertIds

public String[] getCertIds()

Get Filter certificates by the specified certificate id, only supports certificate ids with permission.

Returns:

CertIds Filter certificates by the specified certificate id, only supports certificate ids with permission.

setCertIds

public void setCertIds(String[] CertIds)

Set Filter certificates by the specified certificate id, only supports certificate ids with permission.

Parameters:

CertIds - Filter certificates by the specified certificate id, only supports certificate ids with permission.

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.