crawlercommons.urlfrontier

Class URLFrontierGrpc.URLFrontierStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<URLFrontierGrpc.URLFrontierStub>

crawlercommons.urlfrontier.URLFrontierGrpc.URLFrontierStub

Enclosing class:

URLFrontierGrpc

public static final class URLFrontierGrpc.URLFrontierStub
extends io.grpc.stub.AbstractAsyncStub<URLFrontierGrpc.URLFrontierStub>

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
void	blockQueueUntil(Urlfrontier.BlockQueueParams request, io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver) * Block a queue from sending URLs; the argument is the number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z.
protected URLFrontierGrpc.URLFrontierStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	deleteCrawl(Urlfrontier.DeleteCrawlMessage request, io.grpc.stub.StreamObserver<Urlfrontier.Long> responseObserver) * Delete an entire crawl, returns the number of URLs removed this way *
void	deleteQueue(Urlfrontier.QueueWithinCrawlParams request, io.grpc.stub.StreamObserver<Urlfrontier.Long> responseObserver) * Delete the queue based on the key in parameter, returns the number of URLs removed this way *
void	getActive(Urlfrontier.Local request, io.grpc.stub.StreamObserver<Urlfrontier.Boolean> responseObserver) * Returns true if the crawl is active, false if it has been deactivated with SetActive(Boolean) *
void	getStats(Urlfrontier.QueueWithinCrawlParams request, io.grpc.stub.StreamObserver<Urlfrontier.Stats> responseObserver) * Return stats for a specific queue or an entire crawl.
void	getURLs(Urlfrontier.GetParams request, io.grpc.stub.StreamObserver<Urlfrontier.URLInfo> responseObserver) * Stream URLs due for fetching from M queues with up to N items per queue *
void	listCrawls(Urlfrontier.Local request, io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver) * Return the list of crawls handled by the frontier(s) *
void	listNodes(Urlfrontier.Empty request, io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver) * Return the list of nodes forming the cluster the current node belongs to *
void	listQueues(Urlfrontier.Pagination request, io.grpc.stub.StreamObserver<Urlfrontier.QueueList> responseObserver) * Return a list of queues for a specific crawl.
io.grpc.stub.StreamObserver<Urlfrontier.URLItem>	putURLs(io.grpc.stub.StreamObserver<Urlfrontier.String> responseObserver) * Push URL items to the server; they get created (if they don't already exist) in case of DiscoveredURLItems or updated if KnownURLItems *
void	setActive(Urlfrontier.Active request, io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver) * De/activate the crawl.
void	setDelay(Urlfrontier.QueueDelayParams request, io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver) * Set a delay from a given queue.
void	setLogLevel(Urlfrontier.LogLevelParams request, io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver) * Overrides the log level for a given package *

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected URLFrontierGrpc.URLFrontierStub build(io.grpc.Channel channel,
                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<URLFrontierGrpc.URLFrontierStub>

listNodes

public void listNodes(Urlfrontier.Empty request,
                      io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver)

 * Return the list of nodes forming the cluster the current node belongs to *
 

listCrawls

public void listCrawls(Urlfrontier.Local request,
                       io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver)

 * Return the list of crawls handled by the frontier(s) *
 

deleteCrawl

public void deleteCrawl(Urlfrontier.DeleteCrawlMessage request,
                        io.grpc.stub.StreamObserver<Urlfrontier.Long> responseObserver)

 * Delete an entire crawl, returns the number of URLs removed this way *
 

listQueues

public void listQueues(Urlfrontier.Pagination request,
                       io.grpc.stub.StreamObserver<Urlfrontier.QueueList> responseObserver)

 * Return a list of queues for a specific crawl. Can chose whether to include inactive queues (a queue is active if it has URLs due for fetching);
 by default the service will return up to 100 results from offset 0 and exclude inactive queues.*
 

getURLs

public void getURLs(Urlfrontier.GetParams request,
                    io.grpc.stub.StreamObserver<Urlfrontier.URLInfo> responseObserver)

 * Stream URLs due for fetching from M queues with up to N items per queue *
 

putURLs

public io.grpc.stub.StreamObserver<Urlfrontier.URLItem> putURLs(io.grpc.stub.StreamObserver<Urlfrontier.String> responseObserver)

 * Push URL items to the server; they get created (if they don't already exist) in case of DiscoveredURLItems or updated if KnownURLItems *
 

getStats

public void getStats(Urlfrontier.QueueWithinCrawlParams request,
                     io.grpc.stub.StreamObserver<Urlfrontier.Stats> responseObserver)

 * Return stats for a specific queue or an entire crawl. Does not aggregate the stats across different crawlids. *
 

deleteQueue

public void deleteQueue(Urlfrontier.QueueWithinCrawlParams request,
                        io.grpc.stub.StreamObserver<Urlfrontier.Long> responseObserver)

 * Delete the queue based on the key in parameter, returns the number of URLs removed this way *
 

blockQueueUntil

public void blockQueueUntil(Urlfrontier.BlockQueueParams request,
                            io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)

 * Block a queue from sending URLs; the argument is the number of seconds of UTC time since Unix epoch
 1970-01-01T00:00:00Z. The default value of 0 will unblock the queue. The block will get removed once the time
 indicated in argument is reached. This is useful for cases where a server returns a Retry-After for instance.
 

setActive

public void setActive(Urlfrontier.Active request,
                      io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)

 * De/activate the crawl. GetURLs will not return anything until SetActive is set to true. PutURLs will still take incoming data. *
 

getActive

public void getActive(Urlfrontier.Local request,
                      io.grpc.stub.StreamObserver<Urlfrontier.Boolean> responseObserver)

 * Returns true if the crawl is active, false if it has been deactivated with SetActive(Boolean) *
 

setDelay

public void setDelay(Urlfrontier.QueueDelayParams request,
                     io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)

 * 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.
 

setLogLevel

public void setLogLevel(Urlfrontier.LogLevelParams request,
                        io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)

 * Overrides the log level for a given package *