com.tencentcloudapi.tdmq.v20200217.models

Class DescribeTopicsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.DescribeTopicsRequest

public class DescribeTopicsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeTopicsRequest()
DescribeTopicsRequest(DescribeTopicsRequest 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	getClusterId() Get Pulsar cluster ID.
String	getEnvironmentId() Get Environment (namespace) name.
Filter[]	getFilters() Get * TopicName Query by topic name for exact search.
Long	getLimit() Get The number of results to be returned, which defaults to 10 if left empty.
Long	getOffset() Get Offset, which defaults to 0 if left empty.
Long	getTopicCreator() Get Topic creator: 1: User 2: System
String	getTopicName() Get Fuzzy match by topic name.
Long	getTopicType() Get Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.
void	setClusterId(String ClusterId) Set Pulsar cluster ID.
void	setEnvironmentId(String EnvironmentId) Set Environment (namespace) name.
void	setFilters(Filter[] Filters) Set * TopicName Query by topic name for exact search.
void	setLimit(Long Limit) Set The number of results to be returned, which defaults to 10 if left empty.
void	setOffset(Long Offset) Set Offset, which defaults to 0 if left empty.
void	setTopicCreator(Long TopicCreator) Set Topic creator: 1: User 2: System
void	setTopicName(String TopicName) Set Fuzzy match by topic name.
void	setTopicType(Long TopicType) Set Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.
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

DescribeTopicsRequest

public DescribeTopicsRequest()

DescribeTopicsRequest

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

getEnvironmentId

public String getEnvironmentId()

Get Environment (namespace) name.

Returns:

EnvironmentId Environment (namespace) name.

setEnvironmentId

public void setEnvironmentId(String EnvironmentId)

Set Environment (namespace) name.

Parameters:

EnvironmentId - Environment (namespace) name.

getTopicName

public String getTopicName()

Get Fuzzy match by topic name.

Returns:

TopicName Fuzzy match by topic name.

setTopicName

public void setTopicName(String TopicName)

Set Fuzzy match by topic name.

Parameters:

TopicName - Fuzzy match by topic name.

getOffset

public Long getOffset()

Get Offset, which defaults to 0 if left empty.

Returns:

Offset Offset, which defaults to 0 if left empty.

setOffset

public void setOffset(Long Offset)

Set Offset, which defaults to 0 if left empty.

Parameters:

Offset - Offset, which defaults to 0 if left empty.

getLimit

public Long getLimit()

Get The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20.

Returns:

Limit The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20.

setLimit

public void setLimit(Long Limit)

Set The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20.

Parameters:

Limit - The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20.

getTopicType

public Long getTopicType()

Get Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.

Returns:

TopicType Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.

setTopicType

public void setTopicType(Long TopicType)

Set Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.

Parameters:

TopicType - Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic.

getClusterId

public String getClusterId()

Get Pulsar cluster ID.

Returns:

ClusterId Pulsar cluster ID.

setClusterId

public void setClusterId(String ClusterId)

Set Pulsar cluster ID.

Parameters:

ClusterId - Pulsar cluster ID.

getFilters

public Filter[] getFilters()

Get * TopicName Query by topic name for exact search. Type: String Required: No

Returns:

Filters * TopicName Query by topic name for exact search. Type: String Required: No

setFilters

public void setFilters(Filter[] Filters)

Set * TopicName Query by topic name for exact search. Type: String Required: No

Parameters:

Filters - * TopicName Query by topic name for exact search. Type: String Required: No

getTopicCreator

public Long getTopicCreator()

Get Topic creator: 1: User 2: System

Returns:

TopicCreator Topic creator: 1: User 2: System

setTopicCreator

public void setTopicCreator(Long TopicCreator)

Set Topic creator: 1: User 2: System

Parameters:

TopicCreator - Topic creator: 1: User 2: System

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel