franz

Documentation

Index

• type SyncGroupRequest
  • func NewPtrSyncGroupRequest() *SyncGroupRequest
  • func NewSyncGroupRequest() SyncGroupRequest
  • func (v *SyncGroupRequest) AppendTo(dst []byte) []byte
  • func (v *SyncGroupRequest) Default()
  • func (v *SyncGroupRequest) GetVersion() int16
  • func (v *SyncGroupRequest) IsFlexible() bool
  • func (v *SyncGroupRequest) IsGroupCoordinatorRequest()
  • func (*SyncGroupRequest) Key() int16
  • func (*SyncGroupRequest) MaxVersion() int16
  • func (v *SyncGroupRequest) ReadFrom(src []byte) error
  • func (v *SyncGroupRequest) RequestWith(ctx context.Context, r kmsg.Requestor) (*kmsg.SyncGroupResponse, error)
  • func (v *SyncGroupRequest) ResponseKind() kmsg.Response
  • func (v *SyncGroupRequest) SetVersion(version int16)
• type SyncGroupRequestGroupAssignment
  • func NewSyncGroupRequestGroupAssignment() SyncGroupRequestGroupAssignment
  • func (v *SyncGroupRequestGroupAssignment) Default()

Types

type SyncGroupRequest

type SyncGroupRequest struct {
	// Version is the version of this message used with a Kafka broker.
	Version int16

	// Group is the group ID this sync group is for.
	Group string

	// Generation is the group generation this sync is for.
	Generation int32

	// MemberID is the member ID this member is.
	MemberID string

	// InstanceID is the instance ID of this member in the group (KIP-345).
	InstanceID *string // v3+

	// GroupAssignment, sent only from the group leader, is the topic partition
	// assignment it has decided on for all members.
	GroupAssignment []SyncGroupRequestGroupAssignment

	// UnknownTags are tags Kafka sent that we do not know the purpose of.
	UnknownTags kmsg.Tags // v4+

}

SyncGroupRequest is issued by all group members after they receive a a response for JoinGroup. The group leader is responsible for sending member assignments with the request; all other members do not.

Once the leader sends the group assignment, all members will be replied to.

func NewPtrSyncGroupRequest

func NewPtrSyncGroupRequest() *SyncGroupRequest

NewPtrSyncGroupRequest returns a pointer to a default SyncGroupRequest This is a shortcut for creating a new(struct) and calling Default yourself.

func NewSyncGroupRequest

func NewSyncGroupRequest() SyncGroupRequest

NewSyncGroupRequest returns a default SyncGroupRequest This is a shortcut for creating a struct and calling Default yourself.

func (*SyncGroupRequest) AppendTo

func (v *SyncGroupRequest) AppendTo(dst []byte) []byte

func (*SyncGroupRequest) Default

func (v *SyncGroupRequest) Default()

Default sets any default fields. Calling this allows for future compatibility if new fields are added to SyncGroupRequest.

func (*SyncGroupRequest) GetVersion

func (v *SyncGroupRequest) GetVersion() int16

func (*SyncGroupRequest) IsFlexible

func (v *SyncGroupRequest) IsFlexible() bool

func (*SyncGroupRequest) IsGroupCoordinatorRequest

func (v *SyncGroupRequest) IsGroupCoordinatorRequest()

func (*SyncGroupRequest) Key

func (*SyncGroupRequest) Key() int16

func (*SyncGroupRequest) MaxVersion

func (*SyncGroupRequest) MaxVersion() int16

func (*SyncGroupRequest) ReadFrom

func (v *SyncGroupRequest) ReadFrom(src []byte) error

func (*SyncGroupRequest) RequestWith

func (v *SyncGroupRequest) RequestWith(ctx context.Context, r kmsg.Requestor) (*kmsg.SyncGroupResponse, error)

RequestWith is requests v on r and returns the response or an error. For sharded requests, the response may be merged and still return an error. It is better to rely on client.RequestSharded than to rely on proper merging behavior.

func (*SyncGroupRequest) ResponseKind

func (v *SyncGroupRequest) ResponseKind() kmsg.Response

func (*SyncGroupRequest) SetVersion

func (v *SyncGroupRequest) SetVersion(version int16)

type SyncGroupRequestGroupAssignment

type SyncGroupRequestGroupAssignment struct {
	// MemberID is the member this assignment is for.
	MemberID string

	// MemberAssignment is the assignment for this member. This is typically
	// of type GroupMemberAssignment.
	MemberAssignment []byte

	// UnknownTags are tags Kafka sent that we do not know the purpose of.
	UnknownTags kmsg.Tags // v4+

}

func NewSyncGroupRequestGroupAssignment

func NewSyncGroupRequestGroupAssignment() SyncGroupRequestGroupAssignment

NewSyncGroupRequestGroupAssignment returns a default SyncGroupRequestGroupAssignment This is a shortcut for creating a struct and calling Default yourself.

func (*SyncGroupRequestGroupAssignment) Default

func (v *SyncGroupRequestGroupAssignment) Default()

Default sets any default fields. Calling this allows for future compatibility if new fields are added to SyncGroupRequestGroupAssignment.