Class OffsetAndMetadata

Provide additional metadata when an offset is committed

Hierarchy

OffsetAndMetadata

Index

Constructors

constructor

Methods

Constructors

constructor

new OffsetAndMetadata(): OffsetAndMetadata
new OffsetAndMetadata(obj: OffsetAndMetadata | {}): OffsetAndMetadata

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:737
Returns OffsetAndMetadata
- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:739
Parameters
- obj: OffsetAndMetadata | {}
Returns OffsetAndMetadata

Methods

getMetadata

getMetadata(): string

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:746
Set additional metadata for the offset committed

Returns string

getOffset

getOffset(): number

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:756
Set the offset to commit

Returns number

setMetadata

setMetadata(metadata: string): OffsetAndMetadata

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:751
Set additional metadata for the offset committed

Parameters
- metadata: string
Returns OffsetAndMetadata

setOffset

setOffset(offset: number): OffsetAndMetadata

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:761
Set the offset to commit

Parameters
- offset: number
Returns OffsetAndMetadata

toJson

toJson(): {}

- Defined in io.vertx/vertx-kafka-client/target/npm/options.d.ts:764
Returns {}
- [key: string]: any

Generated using TypeDoc