AsyncDocIdPusher

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.enterprise.adaptor
Interface AsyncDocIdPusher

public interface AsyncDocIdPusher

Interface that allows asynchronous at-will pushing of DocIds to the GSA.

Method Summary
`void`	`pushDocId(DocId docId)` Push a `DocId` asynchronously to the GSA.
`void`	`pushNamedResource(DocId docId, Acl acl)` Push a named resource asynchronously to the GSA.
`void`	`pushRecord(DocIdPusher.Record record)` Push a `Record` asynchronously to the GSA.

Method Detail

pushDocId

void pushDocId(DocId docId)

Push a DocId asynchronously to the GSA. The DocId is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

pushRecord

void pushRecord(DocIdPusher.Record record)

Push a Record asynchronously to the GSA. The Record is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

pushNamedResource

void pushNamedResource(DocId docId,
                       Acl acl)

Push a named resource asynchronously to the GSA. The named resource is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

Named resources are DocIds without any content or metadata, that only exist for ACL inheritance. These DocId will never be visible to the user and have no meaning outside of ACL processing.