com.tencentcloudapi.ckafka.v20190819.models

Class GroupInfoResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.GroupInfoResponse

public class GroupInfoResponse
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GroupInfoResponse()
GroupInfoResponse(GroupInfoResponse 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	getErrorCode() Get Error code.
String	getGroup() Get Kafka consumer group
GroupInfoMember[]	getMembers() Get This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`
String	getProtocol() Get Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`
String	getProtocolType() Get The type of protocol selected by the consumer group, which is `consumer` for common consumers.
String	getState() Get Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state
void	setErrorCode(String ErrorCode) Set Error code.
void	setGroup(String Group) Set Kafka consumer group
void	setMembers(GroupInfoMember[] Members) Set This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`
void	setProtocol(String Protocol) Set Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`
void	setProtocolType(String ProtocolType) Set The type of protocol selected by the consumer group, which is `consumer` for common consumers.
void	setState(String State) Set Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state
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

GroupInfoResponse

public GroupInfoResponse()

GroupInfoResponse

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

getErrorCode

public String getErrorCode()

Get Error code. 0: success

Returns:

ErrorCode Error code. 0: success

setErrorCode

public void setErrorCode(String ErrorCode)

Set Error code. 0: success

Parameters:

ErrorCode - Error code. 0: success

getState

public String getState()

Get Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state

Returns:

State Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state

setState

public void setState(String State)

Set Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state

Parameters:

State - Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in `rebalance` state CompletingRebalance: the consumer group is currently in `rebalance` state Stable: each consumer in the consumer group has joined and is in stable state

getProtocolType

public String getProtocolType()

Get The type of protocol selected by the consumer group, which is `consumer` for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is `connect`. Only with the standard `consumer` protocol can this API get to know the specific assigning method and parse the specific partition assignment

Returns:

ProtocolType The type of protocol selected by the consumer group, which is `consumer` for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is `connect`. Only with the standard `consumer` protocol can this API get to know the specific assigning method and parse the specific partition assignment

setProtocolType

public void setProtocolType(String ProtocolType)

Set The type of protocol selected by the consumer group, which is `consumer` for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is `connect`. Only with the standard `consumer` protocol can this API get to know the specific assigning method and parse the specific partition assignment

Parameters:

ProtocolType - The type of protocol selected by the consumer group, which is `consumer` for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is `connect`. Only with the standard `consumer` protocol can this API get to know the specific assigning method and parse the specific partition assignment

getProtocol

public String getProtocol()

Get Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`

Returns:

Protocol Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`

setProtocol

public void setProtocol(String Protocol)

Set Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`

Parameters:

Protocol - Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`

getMembers

public GroupInfoMember[] getMembers()

Get This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`

Returns:

Members This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`

setMembers

public void setMembers(GroupInfoMember[] Members)

Set This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`

Parameters:

Members - This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`

getGroup

public String getGroup()

Get Kafka consumer group

Returns:

Group Kafka consumer group

setGroup

public void setGroup(String Group)

Set Kafka consumer group

Parameters:

Group - Kafka consumer group

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel