Package com.norconex.committer.googlecloudsearch

Class GoogleCloudSearchCommitter

java.lang.Object

com.norconex.committer.core.AbstractCommitter<GoogleCloudSearchCommitterConfig>

com.norconex.committer.core.batch.AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

com.norconex.committer.googlecloudsearch.GoogleCloudSearchCommitter

All Implemented Interfaces:

BatchConsumer, Committer, Configurable<GoogleCloudSearchCommitterConfig>, AutoCloseable

public class GoogleCloudSearchCommitter
extends AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

Commits documents to Google Cloud Search using the official Google API client. The client root URL is configurable, which makes it possible to run the committer against a local mock server during development and tests.

Raw vs text upload

Text uploads use the committer request content (the parsed/extracted plain text). Raw uploads instead send the original, unparsed document content, which must be captured ahead of time (since parsing normally discards it) into the "binaryContent" metadata field — e.g., using a BinaryContentTransformer pre-parse handler.

ACL mapping

Metadata fields can optionally be mapped to Google Cloud Search ACL principals (readers, denied readers, owners) via GoogleCloudSearchCommitterConfig.setAclMappings(java.util.List), and ACL inheritance from a parent item can be configured via GoogleCloudSearchCommitterConfig.setAclInheritance(GoogleCloudSearchCommitterConfig.AclInheritanceMapping).

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
GoogleCloudSearchCommitter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected void	closeBatchCommitter()	Subclasses can perform additional closing logic by overriding this method.
protected void	commitBatch(Iterator<CommitterRequest> it)	Commits the supplied batch.
boolean	equals(Object o)
GoogleCloudSearchCommitterConfig	getConfiguration()
int	hashCode()
protected void	initBatchCommitter()	Subclasses can perform additional initialization by overriding this method.
String	toString()

Methods inherited from class com.norconex.committer.core.batch.AbstractBatchCommitter

consume, doClean, doClose, doDelete, doInit, doUpsert, getInitializedQueue

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GoogleCloudSearchCommitter

public GoogleCloudSearchCommitter()

Method Details

initBatchCommitter

protected void initBatchCommitter()
                           throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The committer context and committer queue will be already initialized when invoking AbstractCommitter.getCommitterContext() and AbstractBatchCommitter.getInitializedQueue(), respectively.

Overrides:

initBatchCommitter in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

Throws:

CommitterException - error initializing

commitBatch

protected void commitBatch(Iterator<CommitterRequest> it)
                    throws CommitterException

Description copied from class: AbstractBatchCommitter

Commits the supplied batch.

Specified by:

commitBatch in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

Parameters:

it - the batch to commit

Throws:

CommitterException - could not commit the batch

closeBatchCommitter

protected void closeBatchCommitter()
                            throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Overrides:

closeBatchCommitter in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

Throws:

CommitterException - error closing committer

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractBatchCommitter<GoogleCloudSearchCommitterConfig>

getConfiguration

public GoogleCloudSearchCommitterConfig getConfiguration()