Skip to content

Commit 896bd37

Browse files
committed
Regenerated doc for API
Signed-off-by: Julien Nioche <julien@digitalpebble.com>
1 parent bc1eac4 commit 896bd37

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

API/urlfrontier.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [Empty](#urlfrontier-Empty)
1616
- [GetParams](#urlfrontier-GetParams)
1717
- [KnownURLItem](#urlfrontier-KnownURLItem)
18+
- [ListUrlParams](#urlfrontier-ListUrlParams)
1819
- [Local](#urlfrontier-Local)
1920
- [LogLevelParams](#urlfrontier-LogLevelParams)
2021
- [Long](#urlfrontier-Long)
@@ -28,6 +29,7 @@
2829
- [URLInfo](#urlfrontier-URLInfo)
2930
- [URLInfo.MetadataEntry](#urlfrontier-URLInfo-MetadataEntry)
3031
- [URLItem](#urlfrontier-URLItem)
32+
- [URLStatusRequest](#urlfrontier-URLStatusRequest)
3133

3234
- [AckMessage.Status](#urlfrontier-AckMessage-Status)
3335
- [LogLevelParams.Level](#urlfrontier-LogLevelParams-Level)
@@ -216,6 +218,25 @@ it will be elligible for fetching after the delay has elapsed.
216218

217219

218220

221+
<a name="urlfrontier-ListUrlParams"></a>
222+
223+
### ListUrlParams
224+
225+
226+
227+
| Field | Type | Label | Description |
228+
| ----- | ---- | ----- | ----------- |
229+
| start | [uint32](#uint32) | | position of the first result in the list; defaults to 0 |
230+
| size | [uint32](#uint32) | | max number of values; defaults to 100 |
231+
| key | [string](#string) | | ID for the queue * |
232+
| crawlID | [string](#string) | | crawl ID |
233+
| local | [bool](#bool) | | only for the current local instance |
234+
235+
236+
237+
238+
239+
219240
<a name="urlfrontier-Local"></a>
220241

221242
### Local
@@ -437,6 +458,23 @@ Wrapper for a KnownURLItem or DiscoveredURLItem *
437458

438459

439460

461+
462+
<a name="urlfrontier-URLStatusRequest"></a>
463+
464+
### URLStatusRequest
465+
466+
467+
468+
| Field | Type | Label | Description |
469+
| ----- | ---- | ----- | ----------- |
470+
| url | [string](#string) | | URL for which we request info |
471+
| key | [string](#string) | | ID for the queue * |
472+
| crawlID | [string](#string) | | crawl ID - empty string for default |
473+
474+
475+
476+
477+
440478

441479

442480

@@ -493,6 +531,8 @@ Wrapper for a KnownURLItem or DiscoveredURLItem *
493531
| SetDelay | [QueueDelayParams](#urlfrontier-QueueDelayParams) | [Empty](#urlfrontier-Empty) | Set a delay from a given queue. No URLs will be obtained via GetURLs for this queue until the number of seconds specified has elapsed since the last time URLs were retrieved. Usually informed by the delay setting of robots.txt. |
494532
| SetLogLevel | [LogLevelParams](#urlfrontier-LogLevelParams) | [Empty](#urlfrontier-Empty) | Overrides the log level for a given package * |
495533
| SetCrawlLimit | [CrawlLimitParams](#urlfrontier-CrawlLimitParams) | [Empty](#urlfrontier-Empty) | Sets crawl limit for domain * |
534+
| GetURLStatus | [URLStatusRequest](#urlfrontier-URLStatusRequest) | [URLItem](#urlfrontier-URLItem) | Get status of a particular URL This does not take into account URL scheduling. Used to check current status of an URL within the frontier |
535+
| ListURLs | [ListUrlParams](#urlfrontier-ListUrlParams) | [URLItem](#urlfrontier-URLItem) stream | List all URLs currently in the frontier This does not take into account URL scheduling. Used to check current status of all URLs within the frontier |
496536

497537

498538

0 commit comments

Comments
 (0)