com.tencentcloudapi.ssm.v20190923.models

Class ListSecretsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ssm.v20190923.models.ListSecretsRequest

public class ListSecretsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListSecretsRequest()
ListSecretsRequest(ListSecretsRequest 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
Long	getLimit() Get Maximum number of returned Secrets in a query.
Long	getOffset() Get Starting position of the list, starting at 0.
Long	getOrderType() Get Sorting order according to the creation time.
String	getProductName() Get This parameter is valid only when SecretType is `1`.
String	getSearchSecretName() Get Filter according to Secret names.
Long	getSecretType() Get `0` (default): user-defined secret.
Long	getState() Get Filter based on credential status.
TagFilter[]	getTagFilters() Get Tag filter.
void	setLimit(Long Limit) Set Maximum number of returned Secrets in a query.
void	setOffset(Long Offset) Set Starting position of the list, starting at 0.
void	setOrderType(Long OrderType) Set Sorting order according to the creation time.
void	setProductName(String ProductName) Set This parameter is valid only when SecretType is `1`.
void	setSearchSecretName(String SearchSecretName) Set Filter according to Secret names.
void	setSecretType(Long SecretType) Set `0` (default): user-defined secret.
void	setState(Long State) Set Filter based on credential status.
void	setTagFilters(TagFilter[] TagFilters) Set Tag filter.
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, 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

ListSecretsRequest

public ListSecretsRequest()

ListSecretsRequest

public ListSecretsRequest(ListSecretsRequest 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 Starting position of the list, starting at 0. If not specified, 0 is used by default.

Returns:

Offset Starting position of the list, starting at 0. If not specified, 0 is used by default.

setOffset

public void setOffset(Long Offset)

Set Starting position of the list, starting at 0. If not specified, 0 is used by default.

Parameters:

Offset - Starting position of the list, starting at 0. If not specified, 0 is used by default.

getLimit

public Long getLimit()

Get Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.

Returns:

Limit Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.

setLimit

public void setLimit(Long Limit)

Set Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.

Parameters:

Limit - Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.

getOrderType

public Long getOrderType()

Get Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.

Returns:

OrderType Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.

setOrderType

public void setOrderType(Long OrderType)

Set Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.

Parameters:

OrderType - Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.

getState

public Long getState()

Get Filter based on credential status. The default value is 0, indicating to query all. 1: query the list of credentials in `Enabled` status. 2: query the list of credentials in `Disabled` status. 3: query the list of credentials in `PendingDelete` status. 4: query the list of credentials in `PendingCreate` status. 5: query the list of credentials in `CreateFailed` status. The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential

Returns:

State Filter based on credential status. The default value is 0, indicating to query all. 1: query the list of credentials in `Enabled` status. 2: query the list of credentials in `Disabled` status. 3: query the list of credentials in `PendingDelete` status. 4: query the list of credentials in `PendingCreate` status. 5: query the list of credentials in `CreateFailed` status. The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential

setState

public void setState(Long State)

Set Filter based on credential status. The default value is 0, indicating to query all. 1: query the list of credentials in `Enabled` status. 2: query the list of credentials in `Disabled` status. 3: query the list of credentials in `PendingDelete` status. 4: query the list of credentials in `PendingCreate` status. 5: query the list of credentials in `CreateFailed` status. The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential

Parameters:

State - Filter based on credential status. The default value is 0, indicating to query all. 1: query the list of credentials in `Enabled` status. 2: query the list of credentials in `Disabled` status. 3: query the list of credentials in `PendingDelete` status. 4: query the list of credentials in `PendingCreate` status. 5: query the list of credentials in `CreateFailed` status. The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential

getSearchSecretName

public String getSearchSecretName()

Get Filter according to Secret names. If left empty, this filter is not applied.

Returns:

SearchSecretName Filter according to Secret names. If left empty, this filter is not applied.

setSearchSecretName

public void setSearchSecretName(String SearchSecretName)

Set Filter according to Secret names. If left empty, this filter is not applied.

Parameters:

SearchSecretName - Filter according to Secret names. If left empty, this filter is not applied.

getTagFilters

public TagFilter[] getTagFilters()

Get Tag filter.

Returns:

TagFilters Tag filter.

setTagFilters

public void setTagFilters(TagFilter[] TagFilters)

Set Tag filter.

Parameters:

TagFilters - Tag filter.

getSecretType

public Long getSecretType()

Get `0` (default): user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret.

Returns:

SecretType `0` (default): user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret.

setSecretType

public void setSecretType(Long SecretType)

Set `0` (default): user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret.

Parameters:

SecretType - `0` (default): user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret.

getProductName

public String getProductName()

Get This parameter is valid only when SecretType is `1`. An empty value indicates querying all types of Tencent Cloud service secrets. `Mysql`: queries MySQL database credentials. `Tdsql-mysql`: queries TDSQL MySQL database credentials.

Returns:

ProductName This parameter is valid only when SecretType is `1`. An empty value indicates querying all types of Tencent Cloud service secrets. `Mysql`: queries MySQL database credentials. `Tdsql-mysql`: queries TDSQL MySQL database credentials.

setProductName

public void setProductName(String ProductName)

Set This parameter is valid only when SecretType is `1`. An empty value indicates querying all types of Tencent Cloud service secrets. `Mysql`: queries MySQL database credentials. `Tdsql-mysql`: queries TDSQL MySQL database credentials.

Parameters:

ProductName - This parameter is valid only when SecretType is `1`. An empty value indicates querying all types of Tencent Cloud service secrets. `Mysql`: queries MySQL database credentials. `Tdsql-mysql`: queries TDSQL MySQL database credentials.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel