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 Number of results to be returned.
Long	getOffset() Get Offset.
String	getTopicName() Get Fuzzy match by topic name.
Long	getTopicType() Get Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.
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 Number of results to be returned.
void	setOffset(Long Offset) Set Offset.
void	setTopicName(String TopicName) Set Fuzzy match by topic name.
void	setTopicType(Long TopicType) Set Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.
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. If this parameter is left empty, 0 will be used by default.

Returns:

Offset Offset. If this parameter is left empty, 0 will be used by default.

setOffset

public void setOffset(Long Offset)

Set Offset. If this parameter is left empty, 0 will be used by default.

Parameters:

Offset - Offset. If this parameter is left empty, 0 will be used by default.

getLimit

public Long getLimit()

Get Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.

Returns:

Limit Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.

setLimit

public void setLimit(Long Limit)

Set Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.

Parameters:

Limit - Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.

getTopicType

public Long getTopicType()

Get Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.

Returns:

TopicType Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.

setTopicType

public void setTopicType(Long TopicType)

Set Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.

Parameters:

TopicType - Topic type description: 0: general message; 1: globally sequential message; 2: partitionally sequential message; 3: retry letter queue; 4: dead letter queue; 5: transaction message.

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

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel