kafka_admin_class: R6 Class for Kafka Admin

Description Public fields Methods

Description

R6 Class for Kafka Admin

R6 Class for Kafka Admin

Public fields

java_admin

reference to the underlying Java object Initialize

Methods

Public methods


Method new()

Create a new admin object. Instead of kafka_admin_class$new() one can use kafka_admin()

Usage
kafka_admin_class$new()
Returns

returns object reference for method chaining


Method finalize()

Code run when object is removed from session

Usage
kafka_admin_class$finalize()

Method start()

Spin up admin and connect it to Kafka cluster

Usage
kafka_admin_class$start()
Returns

returns object reference for method chaining


Method end()

Disconnect admin from Kafka cluster

Usage
kafka_admin_class$end()
Returns

returns object reference for method chaining


Method restart()

Disconnect and reconnect admin from Kafka cluster

Usage
kafka_admin_class$restart()
Returns

returns object reference for method chaining


Method running()

Whether or not admin is active (has been started or not)

Usage
kafka_admin_class$running()
Returns

TRUE/FALSE


Method props()

Retrieving current current set of properties. If properties are supplied via props parameter thos properties will be set.

Usage
kafka_admin_class$props(..., .properties = NULL)
Arguments
...

a series of properties provided as key = "values"

.properties

a list of properties provided as .properties = list(key = "values", ...)

Returns

returns a list of properties


Method topics_list()

Query and return list of topics.

Usage
kafka_admin_class$topics_list()
Returns

returns a character vector of topics


Method topics_create()

Create new topics

Usage
kafka_admin_class$topics_create(topic, partition = 1, replication_factor = 1)
Arguments
topic

the topic names to create

partition

the topics number of partitions

replication_factor

the topics replication factor

Returns

returns a character vector of topics


Method topics_delete()

Delete topics

Usage
kafka_admin_class$topics_delete(topic)
Arguments
topic
Returns

returns a character vector of topics


Method clone()

The objects of this class are cloneable with this method.

Usage
kafka_admin_class$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


petermeissner/kafkaesque documentation built on Oct. 17, 2020, 8:55 p.m.