crawler-service-enqueue-response

Returned in response to an enqueue request. Child nodes detail the results for each node that the crawler attempted to enqueue.

Attributes

error (Any of: database, invalid-node, invalid-attr, malformed-crawl-url, malformed-crawl-delete, malformed-index-atomic, malformed-crawl-state, terminating, read-only, audit-log-disabled) - If present, indicates that none of the data on the enqueue could be processed and describes the reason why. database: The crawler's database is inaccessible. invalid-node: Attempt to enqueue a node that is not a crawl-url, crawl-urls, or crawl-delete. invalid-attr: Attempt to enqueue a node with an invalid attribute. malformed-crawl-url: Failed to enqueue a crawl-url. Check that there is a url, enqueue-type, or status attribute. malformed-crawl-delete: Failed to enqueue a crawl-delete. You must have a vse-key, url or vertex attribute, but only one per node. malformed-index-atomic: Failed to process an index-atomic nodeset because it is malformed. malformed-crawl-state: Failed to process a crawl-state node because it is malformed. terminating: The crawler is terminating and no additional data may be enqueued until it is restarted. read-only: The crawler is in read-only mode or attempting to enter read-only mode and no additional data may be enqueued until it is restarted. audit-log-disabled: The enqueue request contains a node with the originator attribute, but the audit log is disabled.
n-success (Integer) - If present, indicates the number of URLs that were accepted by by the crawler having made it successfully to the synchronization level requested.
n-failed (Integer) - If present, indicates the number of URLs that were sent to the crawler but did not successfully to the synchronization level requested. When this attribute is present, the first n-failed crawl-url / crawl-deletes will be the ones which were considered to have failed.
n-offline (Integer) - If present, indicates the number of crawl-urls or crawl-deletes that were sent to the crawler's offline queue. These nodes will also contribute to the n-success count, if it is present.
offline-queue-size (xs:unsignedLong) - If an offline queue is present for this collection, this attribute indicates the size of the queue.
pipeline-size (xs:unsignedLong) - If present, indicates the number of unindexed crawl-urls or crawl-deletes in the crawler's pipeline. The value of this attribute is useful to consider when making throttling decisions because under typical usage scenarios the crawler must process the data in the pipeline before indexing new enqueues.
throttle-id (xs:unsignedLong) - If present, indicates the crawler's enqueue-high-water limit has been reached and that the crawler recommends throttling until the enqueue-low-water limit is met. Once the enqueue-lower-water limit is met, the crawler will not return this attribute on the enqueue response until the enqueue-high-water limit is reached again. Upon reaching the enqueue-high-water limit again, the value of this attribute will be different than it was previously.

Children

Choose 1 to unbounded of these in any order.
- index-atomic: (At least 1) - Container for crawl-url and crawl-delete elements that should be indexed together in an atomic operation.
- crawl-url: (At least 1) - A node that encapsulates all crawler state for a particular URL.
- crawl-delete: (At least 1) - A node used to remove a URL or set of URLs from the index.