io.siddhi.doc.gen.extensions

Class ExtensionDocRetriever

java.lang.Object

io.siddhi.doc.gen.extensions.ExtensionDocRetriever

public class ExtensionDocRetriever
extends Object

The ExtensionDocRetriever class provides ability to retrieve all the descriptions for Siddhi extensions. It manages process of retrieving and saving data from remote extension repositories.

Constructor Summary

Constructors

Constructor and Description
ExtensionDocRetriever(String baseGithubId, List<String> extensions, ExtensionDocCache cache)

Method Summary

Modifier and Type	Method and Description
boolean	isThrottled()
boolean	pull() The pull method retrieves corresponding descriptions from extension repositories.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionDocRetriever

public ExtensionDocRetriever(String baseGithubId,
                             List<String> extensions,
                             ExtensionDocCache cache)

Method Detail

pull

public boolean pull()

The pull method retrieves corresponding descriptions from extension repositories. The method only retrieves data if they have been modified in the repository.

Returns:

whether it is a successful pull.

isThrottled

public boolean isThrottled()

Returns:

whether API has reached it's throttling limits.