Class: TencentCloud::Ckafka::V20190819::ModifyGroupOffsetsRequest

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190819/models.rb

Overview

ModifyGroupOffsets请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instanceid = nil, group = nil, strategy = nil, topics = nil, shift = nil, shifttimestamp = nil, offset = nil, partitions = nil) ⇒ ModifyGroupOffsetsRequest

Returns a new instance of ModifyGroupOffsetsRequest.



9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
 
# File 'lib/v20190819/models.rb', line 9267

def initialize(instanceid=nil, group=nil, strategy=nil, topics=nil, shift=nil, shifttimestamp=nil, offset=nil, partitions=nil)
  @InstanceId = instanceid
  @Group = group
  @Strategy = strategy
  @Topics = topics
  @Shift = shift
  @ShiftTimestamp = shifttimestamp
  @Offset = offset
  @Partitions = partitions
end

Instance Attribute Details

#Group ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Group
  @Group
end

#InstanceId ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def InstanceId
  @InstanceId
end

#Offset ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Offset
  @Offset
end

#Partitions ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Partitions
  @Partitions
end

#Shift ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Shift
  @Shift
end

#ShiftTimestamp ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def ShiftTimestamp
  @ShiftTimestamp
end

#Strategy ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Strategy
  @Strategy
end

#Topics ⇒ Object

Parameters:

  • InstanceId: —

    ckafka集群实例Id,可通过DescribeInstances接口获取

  • Group: —

    消费分组名称,可通过DescribeConsumerGroup接口获取

  • Strategy: —

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

  • Topics: —

    需要重置的主题名列表

  • Shift: —

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

  • ShiftTimestamp: —

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

  • Offset: —

    需要重新设置的offset位置。当strategy为2，必须包含该字段。

  • Partitions: —

    需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。



9265
9266
9267
 
# File 'lib/v20190819/models.rb', line 9265

def Topics
  @Topics
end

Instance Method Details

#deserialize(params) ⇒ Object 



9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
 
# File 'lib/v20190819/models.rb', line 9278

def deserialize(params)
  @InstanceId = params['InstanceId']
  @Group = params['Group']
  @Strategy = params['Strategy']
  @Topics = params['Topics']
  @Shift = params['Shift']
  @ShiftTimestamp = params['ShiftTimestamp']
  @Offset = params['Offset']
  @Partitions = params['Partitions']
end