Skip to content

Commit

Permalink
tulios#157 Update README for getTopicMetadata to include multiple topics
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwsperber committed Oct 12, 2018
1 parent 30d325d commit 4dc7960
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -858,9 +858,16 @@ delete.topic.enable=true
### <a name="admin-get-topic-metadata"></a> Get topic metadata

```javascript
await admin.getTopicMetadata(<String>)
await admin.getTopicMetadata({ topics: <Array<String> })
```

`TopicsMetadata` structure:

```javascript
{
topics: <Array<TopicMetadata>>,
}

`TopicMetadata` structure:

```javascript
Expand All @@ -882,7 +889,14 @@ await admin.getTopicMetadata(<String>)
}
```

By default the admin client will throw an exception if the topic does not already exist.
The admin client will throw an exception if any of the provided topics do not already exist.

If you omit the `topics` argument the admin client will fetch metadata for all topics
of which it is already aware (all the cluster's target topics):
```
await admin.getTopicMetadata();
```
### <a name="admin-fetch-offsets"></a> Fetch consumer group offsets
Expand Down

0 comments on commit 4dc7960

Please sign in to comment.