Package com.tencentcloudapi.ckafka.v20190819.models

Class ModifyGroupOffsetsRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getGroup()
      Get kafka 消费分组
      String getInstanceId()
      Get kafka实例id
      Long getOffset()
      Get 需要重新设置的offset位置。当strategy为2，必须包含该字段。
      Long[] getPartitions()
      Get 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。
      Long getShift()
      Get 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest
      Long getShiftTimestamp()
      Get 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
      Long getStrategy()
      Get 重置offset的策略，入参含义 0.
      String[] getTopics()
      Get 表示需要重置的topics， 不填表示全部
      void setGroup​(String Group)
      Set kafka 消费分组
      void setInstanceId​(String InstanceId)
      Set kafka实例id
      void setOffset​(Long Offset)
      Set 需要重新设置的offset位置。当strategy为2，必须包含该字段。
      void setPartitions​(Long[] Partitions)
      Set 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。
      void setShift​(Long Shift)
      Set 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest
      void setShiftTimestamp​(Long ShiftTimestamp)
      Set 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
      void setStrategy​(Long Strategy)
      Set 重置offset的策略，入参含义 0.
      void setTopics​(String[] Topics)
      Set 表示需要重置的topics， 不填表示全部
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • ModifyGroupOffsetsRequest

        public ModifyGroupOffsetsRequest()

      • ModifyGroupOffsetsRequest

        public ModifyGroupOffsetsRequest​(ModifyGroupOffsetsRequest 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

      • getInstanceId

        public String getInstanceId()
        Get kafka实例id
        Returns:
        InstanceId kafka实例id

      • setInstanceId

        public void setInstanceId​(String InstanceId)
        Set kafka实例id
        Parameters:
        InstanceId - kafka实例id

      • getGroup

        public String getGroup()
        Get kafka 消费分组
        Returns:
        Group kafka 消费分组

      • setGroup

        public void setGroup​(String Group)
        Set kafka 消费分组
        Parameters:
        Group - kafka 消费分组

      • getStrategy

        public Long getStrategy()
        Get 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置
        Returns:
        Strategy 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置

      • setStrategy

        public void setStrategy​(Long Strategy)
        Set 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置
        Parameters:
        Strategy - 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置

      • getTopics

        public String[] getTopics()
        Get 表示需要重置的topics， 不填表示全部
        Returns:
        Topics 表示需要重置的topics， 不填表示全部

      • setTopics

        public void setTopics​(String[] Topics)
        Set 表示需要重置的topics， 不填表示全部
        Parameters:
        Topics - 表示需要重置的topics， 不填表示全部

      • getShift

        public Long getShift()
        Get 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest
        Returns:
        Shift 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest

      • setShift

        public void setShift​(Long Shift)
        Set 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest
        Parameters:
        Shift - 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest

      • getShiftTimestamp

        public Long getShiftTimestamp()
        Get 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
        Returns:
        ShiftTimestamp 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。

      • setShiftTimestamp

        public void setShiftTimestamp​(Long ShiftTimestamp)
        Set 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
        Parameters:
        ShiftTimestamp - 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。

      • getOffset

        public Long getOffset()
        Get 需要重新设置的offset位置。当strategy为2，必须包含该字段。
        Returns:
        Offset 需要重新设置的offset位置。当strategy为2，必须包含该字段。

      • setOffset

        public void setOffset​(Long Offset)
        Set 需要重新设置的offset位置。当strategy为2，必须包含该字段。
        Parameters:
        Offset - 需要重新设置的offset位置。当strategy为2，必须包含该字段。

      • getPartitions

        public Long[] getPartitions()
        Get 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。
        Returns:
        Partitions 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。

      • setPartitions

        public void setPartitions​(Long[] Partitions)
        Set 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。
        Parameters:
        Partitions - 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。