com.tencentcloudapi.tdmq.v20200217.models

Class DescribeCmqTopicsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.DescribeCmqTopicsRequest

public class DescribeCmqTopicsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeCmqTopicsRequest()
DescribeCmqTopicsRequest(DescribeCmqTopicsRequest 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
Filter[]	getFilters() Get Filter.
Boolean	getIsTagFilter() Get For filtering by tag, this parameter must be set to `true`.
Long	getLimit() Get The number of queues to be returned per page in case of paginated return.
Long	getOffset() Get Starting position of a queue list to be returned on the current page in case of paginated return.
String	getTopicName() Get Fuzzy search by `TopicName`
String[]	getTopicNameList() Get Filter by CMQ topic name.
void	setFilters(Filter[] Filters) Set Filter.
void	setIsTagFilter(Boolean IsTagFilter) Set For filtering by tag, this parameter must be set to `true`.
void	setLimit(Long Limit) Set The number of queues to be returned per page in case of paginated return.
void	setOffset(Long Offset) Set Starting position of a queue list to be returned on the current page in case of paginated return.
void	setTopicName(String TopicName) Set Fuzzy search by `TopicName`
void	setTopicNameList(String[] TopicNameList) Set Filter by CMQ topic name.
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

DescribeCmqTopicsRequest

public DescribeCmqTopicsRequest()

DescribeCmqTopicsRequest

public DescribeCmqTopicsRequest(DescribeCmqTopicsRequest 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 a queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` must be specified. If this parameter is left empty, 0 will be used by default.

Returns:

Offset Starting position of a queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` must be specified. If this parameter is left empty, 0 will be used by default.

setOffset

public void setOffset(Long Offset)

Set Starting position of a queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` must be specified. If this parameter is left empty, 0 will be used by default.

Parameters:

Offset - Starting position of a queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` must be specified. If this parameter is left empty, 0 will be used by default.

getLimit

public Long getLimit()

Get The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.

Returns:

Limit The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.

setLimit

public void setLimit(Long Limit)

Set The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.

Parameters:

Limit - The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.

getTopicName

public String getTopicName()

Get Fuzzy search by `TopicName`

Returns:

TopicName Fuzzy search by `TopicName`

setTopicName

public void setTopicName(String TopicName)

Set Fuzzy search by `TopicName`

Parameters:

TopicName - Fuzzy search by `TopicName`

getTopicNameList

public String[] getTopicNameList()

Get Filter by CMQ topic name.

Returns:

TopicNameList Filter by CMQ topic name.

setTopicNameList

public void setTopicNameList(String[] TopicNameList)

Set Filter by CMQ topic name.

Parameters:

TopicNameList - Filter by CMQ topic name.

getIsTagFilter

public Boolean getIsTagFilter()

Get For filtering by tag, this parameter must be set to `true`.

Returns:

IsTagFilter For filtering by tag, this parameter must be set to `true`.

setIsTagFilter

public void setIsTagFilter(Boolean IsTagFilter)

Set For filtering by tag, this parameter must be set to `true`.

Parameters:

IsTagFilter - For filtering by tag, this parameter must be set to `true`.

getFilters

public Filter[] getFilters()

Get Filter. Currently, you can filter by tag. The tag name must be prefixed with “tag:”, such as “tag: owner”, “tag: environment”, or “tag: business”.

Returns:

Filters Filter. Currently, you can filter by tag. The tag name must be prefixed with “tag:”, such as “tag: owner”, “tag: environment”, or “tag: business”.

setFilters

public void setFilters(Filter[] Filters)

Set Filter. Currently, you can filter by tag. The tag name must be prefixed with “tag:”, such as “tag: owner”, “tag: environment”, or “tag: business”.

Parameters:

Filters - Filter. Currently, you can filter by tag. The tag name must be prefixed with “tag:”, such as “tag: owner”, “tag: environment”, or “tag: business”.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel