Skip to content

Commit

Permalink
Merge pull request #1367 from kjgorman/producer-message-timestamp-doc…
Browse files Browse the repository at this point in the history
…umentation

async_producer: clarify ProducerMessage `Timestamp` doc
  • Loading branch information
bai authored May 3, 2019
2 parents ea9ab1c + 1889f36 commit 457a8e6
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions async_producer.go
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,17 @@ type ProducerMessage struct {
// Partition is the partition that the message was sent to. This is only
// guaranteed to be defined if the message was successfully delivered.
Partition int32
// Timestamp is the timestamp assigned to the message by the broker. This
// is only guaranteed to be defined if the message was successfully
// delivered, RequiredAcks is not NoResponse, and the Kafka broker is at
// least version 0.10.0.
// Timestamp can vary in behaviour depending on broker configuration, being
// in either one of the CreateTime or LogAppendTime modes (default CreateTime),
// and requiring version at least 0.10.0.
//
// When configured to CreateTime, the timestamp is specified by the producer
// either by explicitly setting this field, or when the message is added
// to a produce set.
//
// When configured to LogAppendTime, the timestamp assigned to the message
// by the broker. This is only guaranteed to be defined if the message was
// successfully delivered and RequiredAcks is not NoResponse.
Timestamp time.Time

retries int
Expand Down

0 comments on commit 457a8e6

Please sign in to comment.