Page History

{
  "apiKey": TBD,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "ConsumerGroupInstallAssignmentRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "TopicNameGroupId", "type": "string", "versions": "0+",
 "entityType": "groupId",
        "about": "The topicgroup nameidentifier." },
        { "name": "NumPartitionsMemberId", "type": "int32", "versions": "0+",
          "about": "The number of partitions." }
    ]}    
  ]
} 

package org.apache.kafka.server.group.consumer;

public interface PartitionAssignor {

    class Group    class AssignmentSpec {
        /**
                  * The members keyed by member id.
         */
        List<GroupMember>        Map<String, AssignmentMemberSpec> members;

        /**
                  * The topics' metadata. keyed by topic id
         */
        List<TopicMetadata>        Map<Uuid, AssignmentTopicMetadata> topics;
        }

    class GroupMember {
        /**
         * The member ID.
         */
        String memberId;

class AssignmentMemberSpec {
        /**
         * The instance ID if provided.
         */
        Optional<String>        Optional<String> instanceId;

        /**
         * The rack ID if provided.
         */
        Optional<String>       Optional<String> rackId;

         /**
         * The set of topic IDs that the member is subscribed to.
         */
        List<Uuid>        List<Uuid> subscribedTopicIds;

        /**
                  * The current target partitions owned byof the member at the current epoch.
         */
        List<TopicIdPartition> ownedPartitions;
            List<TopicIdPartition> targetPartitions;
    }

     class TopicMetadataAssignmentTopicMetadata {
      	  /**
		         * The topic IDname.
		         */
		Uuid topicId        String topicName;

        /**
		 * The number of partitions.
		 */
		int numPartitions; 
    } 

      classclass AssignmentGroupAssignment {
        /**
                  * The member assignmentassignments keyed by member id.
         */
        List<MemberAssignment>        Map<String, MemberAssignment> members;
      }

    class    class MemberAssignment {
        /**
         * The target partitions assigned to this member ID.
         */
        String memberId;

        /**
         * The assigned partitions.
         */
        List<TopicIdPartition> partitions;
            List<TopicIdPartition> targetPartitions;
    }

    /**
     * Unique name for this assignor.
     */
    String    String name();

    /**
     * Perform the group assignment given the current members and
     * topic metadata.
     *
     * @param groupassignmentSpec The groupassignment statespec.
     * @return The new assignment for the group.
     */
    Assignment    Assignment assign(GroupAssignmentSpec groupassignmentSpec) throws PartitionAssignorException;
}

package org.apache.kafka.clients.consumer;
  
public interface PartitionAssignor {

    class Metadata {
        /**
         * The metadata version.
         */
        int version;

        /**
         * The metadata bytes.
         */
        ByteBuffer bytes;
    }

    class AssignmentSpec

package org.apache.kafka.clients.consumer;

public interface PartitionAssignor {

    class Group {
        /**
                  * The members keyed by member id.
         */
        List<GroupMember>        Map<String, AssignmentMemberSpec> members;

        /**
                  * The topics' metadata. keyed by topic id
         */
        List<TopicMetadata>        Map<Uuid, AssignmentTopicMetadata> topics;
        }

    class GroupMember {
        /**
         * The member ID.
         */
        String memberId;

class AssignmentMemberSpec {
        /**
         * The instance ID if provided.
         */
        Optional<String>        Optional<String> instanceId;

        /**
         * The rack ID if provided.
         */
        Optional<String>
        Optional<String> rackId;

        /**
         * The set of topic IDs that the member is subscribed to.
         */
        List<Uuid>        List<Uuid> subscribedTopicIds;

   		/**
		 * The reason reported by the member.
		 */
		byte reason;  

		/**
		 * The version of the metadata encodedreported inby {{@link GroupMember#metadata()}}the member.
		 */
		int version        Metadata metadata;

        /**
                  * The customcurrent metadatatarget providedpartitions byof the member as defined
         * by {{@link PartitionAssignor#metadata()}}.
         */
        ByteBuffer metadata;

        /**
         * The partitions owned by the member at the current epoch.
         */
        List<TopicIdPartition> ownedPartitions;
            List<TopicIdPartition> targetPartitions;
    }

    class TopicMetadataAssignmentTopicMetadata {
        	/**
		         * The topic IDname.
		         */
		Uuid topicId        String topicName;

        /**
		 * The number of partitions.
		 */
		int numPartitions; 
    }

    class Assignment    class GroupAssignment {
        /**
         * The assignment error.
         */
		byte error;

        /**
                  * The member assignment assignments keyed by member id.
         */
        List<MemberAssignment>        Map<String, MemberAssignment> members;
      }

    class MemberAssignment {
        /**
         * The member ID.
         */
        String memberId;

    class MemberAssignment {
        /**
         * The target partitions assigned to this partitionsmember.
         */
        List<TopicIdPartition> partitions;

  		/**
		 * The error reported by the assignor.
		 */
		byte error; List<TopicIdPartition> targetPartitions;

 		/**
		 * The version of the metadata encoded in {{@link GroupMember#metadata()}}.
		 */
		intMetadata versionmetadata;

        /**
         * The custom metadata provided by the assignor.
         */
        ByteBuffer metadata;
    }

	class MetadataAssignorMetadata {
   		/**
		 * The reason reported by the assignor.
		 */
		byte reason; 

 		/**
		 * The version of the metadata encodedreported inby {{@link Metadata#metadata()}}the assignor.
		 */
		int version;

        /**
         * The custom metadata provided by the assignor.
         */
        ByteBuffer metadata; Metadata metadata;
    }

    /**
     * Unique name for this assignor.
     */
    String    String name();

    /**
     * The minimum version.
     */
    int    int minimumVersion();

    /**
     * The maximum version.
     */
    int    int maximumVersion();

    /**
     * Return serializedassignor datametadata that will be sent to the assignor.
     */
    Metadata    AssignorMetadata metadata();

    /**
     * Perform the group assignment given the current members and
     * topic metadata.
     *
     * @param groupassignmentSpec The groupassignment statespec.
     * @return The new assignment for the group.
     */
    Assignment    Assignment assign(GroupAssignmentSpec groupassignmentSpec);

    /**
     * Callback which is invoked when the member received a new assignment 
     * assignment from the assignor/group coordinator. This is called once per epoch
     * and contains the target partitions for this members. This means that
     * partitions may not be assigned to the member yet. The rebalance
     * listener must be used to know this.
     * 
     * @param byte The error reported by the assignor.
     * @param assignment The assignment computed by the assignor.
     * @param consumerGroupMetadata The group metadata.
     */
    void    void onAssignment(byte error, MemberAssignment assignment, ConsumerGroupMetadata consumerGroupMetadata);
}