All Implemented Interfaces:: java.lang.AutoCloseable


public class Driver
 implements AutoCloseable

The pulsar driver

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Duration`	`timeout`
`private final String`	`scrapeBaseUrl`
`private final String`	`scrapeApi`
`private final String`	`statusApi`
`private final String`	`statusesApi`
`private final String`	`userBaseUri`
`private final String`	`dashboardApi`
`private final String`	`countApi`
`private final String`	`fetchApi`
`private final String`	`downloadApi`
`private final String`	`statusQueryApi`

Constructor Summary

Constructors
Constructor	Description
`Driver(DriverSettings settings)`
`Driver(String server, String authToken, Integer port, String contextPath, Duration httpTimeout)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Duration`	`getTimeout()`
`final Unit`	`setTimeout(Duration timeout)`
`final String`	`getScrapeBaseUrl()`
`final String`	`getScrapeApi()`
`final String`	`getStatusApi()`
`final String`	`getStatusesApi()`
`final String`	`getUserBaseUri()`
`final String`	`getDashboardApi()`
`final String`	`getCountApi()`
`final String`	`getFetchApi()`
`final String`	`getDownloadApi()`
`final String`	`getStatusQueryApi()`
`final String`	`submit(String sql, Integer priority, Boolean asap)`	Submit an SQL to scrape
`final List<String>`	`submitAll(Iterable<String> sqls, Integer priority, Boolean asap)`	Submit SQLs to scrape
`final Dashboard`	`dashboard()`	Show my dashboard
`final ScrapeResponse`	`findById(String id)`	Find a scrape response by scrape task id which returned by submit
`final List<ScrapeResponse>`	`findAllByIds(Iterable<String> ids)`	Find scrape responses by scrape task ids which returned by submit
`final Long`	`count()`	Count all submitted tasks
`final List<CompactedScrapeResponse>`	`fetch(Long offset, Integer limit)`	Fetch limit scrape responses start from offset
`final Page<CompactedScrapeResponse>`	`download(Integer pageNumber, Integer pageSize)`	Download scrape responses page by page
`final Gson`	`createGson()`
`Unit`	`close()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Driver
```
Driver(DriverSettings settings)
```

Driver

Driver(String server, String authToken, Integer port, String contextPath, Duration httpTimeout)

Method Detail

getTimeout
```
 final Duration getTimeout()
```

setTimeout

 final Unit setTimeout(Duration timeout)

getScrapeBaseUrl
```
 final String getScrapeBaseUrl()
```

getScrapeApi
```
 final String getScrapeApi()
```

getStatusApi
```
 final String getStatusApi()
```

getStatusesApi
```
 final String getStatusesApi()
```

getUserBaseUri
```
 final String getUserBaseUri()
```

getDashboardApi
```
 final String getDashboardApi()
```

getCountApi
```
 final String getCountApi()
```

getFetchApi
```
 final String getFetchApi()
```

getDownloadApi
```
 final String getDownloadApi()
```

getStatusQueryApi
```
 final String getStatusQueryApi()
```

submit

 final String submit(String sql, Integer priority, Boolean asap)

Submit an SQL to scrape

submitAll

 final List<String> submitAll(Iterable<String> sqls, Integer priority, Boolean asap)

Submit SQLs to scrape

dashboard
```
 final Dashboard dashboard()
```
Show my dashboard

findById
```
 final ScrapeResponse findById(String id)
```
Find a scrape response by scrape task id which returned by submit

findAllByIds
```
 final List<ScrapeResponse> findAllByIds(Iterable<String> ids)
```
Find scrape responses by scrape task ids which returned by submit

count
```
 final Long count()
```
Count all submitted tasks

fetch

 final List<CompactedScrapeResponse> fetch(Long offset, Integer limit)

Fetch limit scrape responses start from offset

download

 final Page<CompactedScrapeResponse> download(Integer pageNumber, Integer pageSize)

Download scrape responses page by page

createGson
```
 final Gson createGson()
```

close
```
 Unit close()
```

Class Driver

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Driver

Driver

Method Detail

getTimeout

setTimeout

getScrapeBaseUrl

getScrapeApi

getStatusApi

getStatusesApi

getUserBaseUri

getDashboardApi

getCountApi

getFetchApi

getDownloadApi

getStatusQueryApi

submit

submitAll

dashboard

findById

findAllByIds

count

fetch

download

createGson

close