com.tencentcloudapi.ckafka.v20190819.models

Class ModifyGroupOffsetsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.ModifyGroupOffsetsRequest

public class ModifyGroupOffsetsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifyGroupOffsetsRequest()

Method Summary

Modifier and Type	Method and Description
String	getGroup() Get Kafka consumer group
String	getInstanceId() Get Kafka instance ID
Long	getOffset() Get Position of the offset that needs to be reset.
Long	getShift() Get When `strategy` is 0, this field is required.
Long	getShiftTimestamp() Get Unit: ms.
Long	getStrategy() Get Offset resetting policy.
String[]	getTopics() Get Indicates the topics to be reset.
void	setGroup(String Group) Set Kafka consumer group
void	setInstanceId(String InstanceId) Set Kafka instance ID
void	setOffset(Long Offset) Set Position of the offset that needs to be reset.
void	setShift(Long Shift) Set When `strategy` is 0, this field is required.
void	setShiftTimestamp(Long ShiftTimestamp) Set Unit: ms.
void	setStrategy(Long Strategy) Set Offset resetting policy.
void	setTopics(String[] Topics) Set Indicates the topics to be reset.
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

ModifyGroupOffsetsRequest

public ModifyGroupOffsetsRequest()

Method Detail

getInstanceId

public String getInstanceId()

Get Kafka instance ID

Returns:

InstanceId Kafka instance ID

setInstanceId

public void setInstanceId(String InstanceId)

Set Kafka instance ID

Parameters:

InstanceId - Kafka instance ID

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

getStrategy

public Long getStrategy()

Get Offset resetting policy. Meanings of the input parameters: 0: equivalent to the `shift-by` parameter, which indicates to shift the offset forward or backward by the value of the `shift`. 1: equivalent to `by-duration`, `to-datetime`, `to-earliest`, or `to-latest`, which indicates to move the offset to the specified timestamp. 2: equivalent to `to-offset`, which indicates to move the offset to the specified offset position

Returns:

Strategy Offset resetting policy. Meanings of the input parameters: 0: equivalent to the `shift-by` parameter, which indicates to shift the offset forward or backward by the value of the `shift`. 1: equivalent to `by-duration`, `to-datetime`, `to-earliest`, or `to-latest`, which indicates to move the offset to the specified timestamp. 2: equivalent to `to-offset`, which indicates to move the offset to the specified offset position

setStrategy

public void setStrategy(Long Strategy)

Set Offset resetting policy. Meanings of the input parameters: 0: equivalent to the `shift-by` parameter, which indicates to shift the offset forward or backward by the value of the `shift`. 1: equivalent to `by-duration`, `to-datetime`, `to-earliest`, or `to-latest`, which indicates to move the offset to the specified timestamp. 2: equivalent to `to-offset`, which indicates to move the offset to the specified offset position

Parameters:

Strategy - Offset resetting policy. Meanings of the input parameters: 0: equivalent to the `shift-by` parameter, which indicates to shift the offset forward or backward by the value of the `shift`. 1: equivalent to `by-duration`, `to-datetime`, `to-earliest`, or `to-latest`, which indicates to move the offset to the specified timestamp. 2: equivalent to `to-offset`, which indicates to move the offset to the specified offset position

getTopics

public String[] getTopics()

Get Indicates the topics to be reset. If this parameter is left empty, all topics will be reset

Returns:

Topics Indicates the topics to be reset. If this parameter is left empty, all topics will be reset

setTopics

public void setTopics(String[] Topics)

Set Indicates the topics to be reset. If this parameter is left empty, all topics will be reset

Parameters:

Topics - Indicates the topics to be reset. If this parameter is left empty, all topics will be reset

getShift

public Long getShift()

Get When `strategy` is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the `shift`. If it is below zero, the offset will be shifted forward by the value of the `shift`. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the `earliest` parameter of the partition, it will be set to `earliest`, and if it is greater than the `latest` parameter of the partition, it will be set to `latest`

Returns:

Shift When `strategy` is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the `shift`. If it is below zero, the offset will be shifted forward by the value of the `shift`. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the `earliest` parameter of the partition, it will be set to `earliest`, and if it is greater than the `latest` parameter of the partition, it will be set to `latest`

setShift

public void setShift(Long Shift)

Set When `strategy` is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the `shift`. If it is below zero, the offset will be shifted forward by the value of the `shift`. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the `earliest` parameter of the partition, it will be set to `earliest`, and if it is greater than the `latest` parameter of the partition, it will be set to `latest`

Parameters:

Shift - When `strategy` is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the `shift`. If it is below zero, the offset will be shifted forward by the value of the `shift`. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the `earliest` parameter of the partition, it will be set to `earliest`, and if it is greater than the `latest` parameter of the partition, it will be set to `latest`

getShiftTimestamp

public Long getShiftTimestamp()

Get Unit: ms. When `strategy` is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained

Returns:

ShiftTimestamp Unit: ms. When `strategy` is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained

setShiftTimestamp

public void setShiftTimestamp(Long ShiftTimestamp)

Set Unit: ms. When `strategy` is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained

Parameters:

ShiftTimestamp - Unit: ms. When `strategy` is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained

getOffset

public Long getOffset()

Get Position of the offset that needs to be reset. When `strategy` is 2, this field is required

Returns:

Offset Position of the offset that needs to be reset. When `strategy` is 2, this field is required

setOffset

public void setOffset(Long Offset)

Set Position of the offset that needs to be reset. When `strategy` is 2, this field is required

Parameters:

Offset - Position of the offset that needs to be reset. When `strategy` is 2, this field is required

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel