Class SimpleConsumeAction

java.lang.Object

io.confluent.kafkarest.resources.v3.SimpleConsumeAction

@Path("/v3/clusters/{clusterId}/internal/topics/{topicName}")
public final class SimpleConsumeAction
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_MESSAGE_MAX_BYTES_CANNOT_BE_NEGATIVE
static final int	MAX_POLL_RECORDS_LIMIT	max_poll_records is the parameter that shows the maximum number of messages to be returned.

Constructor Summary

Constructors

Constructor	Description
SimpleConsumeAction(jakarta.inject.Provider<io.confluent.kafkarest.controllers.TopicManager> topicManager, jakarta.inject.Provider<SimpleConsumeManager> simpleConsumeManager)

Method Summary

Modifier and Type	Method	Description
void	consumeFromPartition(jakarta.ws.rs.container.AsyncResponse asyncResponse, String clusterId, String topicName, Integer partitionId, String fromBeginningParam, String offsetParam, String timestampParam, Integer maxPollRecords, Integer fetchMaxBytes, Integer messageMaxBytes)	Consume from single partition
void	consumeFromPartitions(jakarta.ws.rs.container.AsyncResponse asyncResponse, String clusterId, String topicName, boolean returnRawBase64Records, @Valid SimpleConsumeMultiPartitionRequest request)	Consume from multiple partitions, there is no guarantee all partitions are returning records
void	consumeFromPartitionsGuaranteeProgress(jakarta.ws.rs.container.AsyncResponse asyncResponse, String clusterId, String topicName, boolean returnRawBase64Records, @Valid SimpleConsumeMultiPartitionRequest request)	Consume from multiple partitions, guarantee that all partitions are returning records
void	getOffsetsForPartition(jakarta.ws.rs.container.AsyncResponse asyncResponse, String clusterId, String topicName, Integer partitionId, String fromBeginningParam, String timestampParam)
void	getOffsetsForPartitions(jakarta.ws.rs.container.AsyncResponse asyncResponse, String clusterId, String topicName, String fromBeginningParam, String timestampParam)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_POLL_RECORDS_LIMIT

public static final int MAX_POLL_RECORDS_LIMIT

max_poll_records is the parameter that shows the maximum number of messages to be returned. It's set as 2000 per UI usage. It won't be exceeding 2000 records for one query usage

See Also:

• Constant Field Values

ERROR_MESSAGE_MAX_BYTES_CANNOT_BE_NEGATIVE

public static final String ERROR_MESSAGE_MAX_BYTES_CANNOT_BE_NEGATIVE

See Also:

• Constant Field Values

Constructor Details

SimpleConsumeAction

@Inject
public SimpleConsumeAction(jakarta.inject.Provider<io.confluent.kafkarest.controllers.TopicManager> topicManager,
 jakarta.inject.Provider<SimpleConsumeManager> simpleConsumeManager)

Method Details

consumeFromPartition

@GET
@Path("/partitions/{partitionId}/records")
@Consumes("application/json")
@Produces("application/json")
@PerformanceMetric("v3.simple-consume.1-partition")
public void consumeFromPartition(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterId")
 String clusterId,
 @PathParam("topicName")
 String topicName,
 @PathParam("partitionId")
 Integer partitionId,
 @QueryParam("from_beginning")
 String fromBeginningParam,
 @QueryParam("offset")
 String offsetParam,
 @QueryParam("timestamp")
 String timestampParam,
 @QueryParam("max_poll_records")
 Integer maxPollRecords,
 @QueryParam("fetch_max_bytes")
 Integer fetchMaxBytes,
 @QueryParam("message_max_bytes")
 Integer messageMaxBytes)

Consume from single partition

consumeFromPartitions

@POST
@Path("/partitions/-/records:consume")
@Consumes("application/json")
@Produces("application/json")
@PerformanceMetric("v3.simple-consume.n-partitions")
public void consumeFromPartitions(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterId")
 String clusterId,
 @PathParam("topicName")
 String topicName,
 @QueryParam("return_raw_base64_records") @DefaultValue("false")
 boolean returnRawBase64Records,
 @Valid
 @Valid SimpleConsumeMultiPartitionRequest request)

Consume from multiple partitions, there is no guarantee all partitions are returning records

consumeFromPartitionsGuaranteeProgress

@POST
@Path("/partitions/-/records:consume_guarantee_progress")
@Consumes("application/json")
@Produces("application/json")
@PerformanceMetric("v3.simple-consume.n-partitions-guarantee-progress")
public void consumeFromPartitionsGuaranteeProgress(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterId")
 String clusterId,
 @PathParam("topicName")
 String topicName,
 @QueryParam("return_raw_base64_records") @DefaultValue("false")
 boolean returnRawBase64Records,
 @Valid
 @Valid SimpleConsumeMultiPartitionRequest request)

Consume from multiple partitions, guarantee that all partitions are returning records

getOffsetsForPartition

@GET
@Path("/partitions/{partitionId}/records:offsets")
@Consumes("application/json")
@Produces("application/json")
@PerformanceMetric("v3.simple-consume.offsets-1-partition")
public void getOffsetsForPartition(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterId")
 String clusterId,
 @PathParam("topicName")
 String topicName,
 @PathParam("partitionId")
 Integer partitionId,
 @QueryParam("from_beginning")
 String fromBeginningParam,
 @QueryParam("timestamp")
 String timestampParam)

getOffsetsForPartitions

@GET
@Path("/partitions/-/records:offsets")
@Consumes("application/json")
@Produces("application/json")
@PerformanceMetric("v3.simple-consume.offsets-n-partitions")
public void getOffsetsForPartitions(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterId")
 String clusterId,
 @PathParam("topicName")
 String topicName,
 @QueryParam("from_beginning")
 String fromBeginningParam,
 @QueryParam("timestamp")
 String timestampParam)