com.attivio.sdk.ingest

Class Optimize

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.ingest.AbstractIndexMessage

com.attivio.sdk.ingest.Optimize

All Implemented Interfaces:

PlatformMessage, IndexMessage, Serializable, Cloneable

public class Optimize
extends AbstractIndexMessage

Represents an 'optimize' index message.

The specifics of an optimize is left up to the underlying data storage system. In general an optimize should put the storage system in a state that is most efficient for future work. Note that an optimize does not specify if future queries or future indexing are favored for efficiency.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Optimize.BackgroundMode BackgroundMode specifies if optimize will block ingestion of documents while running.
static class	Optimize.OptimizeMode Mode for determining how the index will be optimized.

Field Summary

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor and Description
Optimize() The default constructor
Optimize(UUID cid, String... workflows) Constructor with a client ID and workflows.
Optimize(UUID cid, WorkflowQueue workflows) Constructor with a client ID and a workflow queue.

Method Summary

Modifier and Type	Method and Description
Optimize	clone() Clones the object and resets message ID to -1.
boolean	equals(Object other)
Optimize.BackgroundMode	getBackgroundMode() Get the Optimize.BackgroundMode for this message.
Optimize.OptimizeMode	getMode() Get the optimization mode.
List<String>	getZones() Expert: Get the list of zones to commit as part of this message.
int	hashCode()
boolean	isCommit() Get if this optimize message will commit outstanding documents.
void	setBackgroundMode(Optimize.BackgroundMode value) Set the Optimize.BackgroundMode for this message.
void	setCommit(boolean value) Set if this optimize message should commit outstanding documents.
void	setMode(Optimize.OptimizeMode value) Set the optimization mode.
void	setZones(List<String> value) Expert: Set the list of zones to commit as part of this message.
void	setZones(String... value) Expert: Set the list of zones to commit as part of this message.

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.attivio.sdk.esb.PlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getWorkflowQueue, getWorkflowQueue, isRedelivered, removeProperty, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString

Constructor Detail

Optimize

public Optimize()

The default constructor

Optimize

public Optimize(UUID cid,
                String... workflows)

Constructor with a client ID and workflows.

Parameters:

cid - the client ID

workflows - the workflows

Optimize

public Optimize(UUID cid,
                WorkflowQueue workflows)

Constructor with a client ID and a workflow queue.

Parameters:

cid - the client ID

workflows - the workflow queue

Method Detail

getMode

public Optimize.OptimizeMode getMode()

Get the optimization mode.

setMode

public void setMode(Optimize.OptimizeMode value)

Set the optimization mode.

getBackgroundMode

public Optimize.BackgroundMode getBackgroundMode()

Get the Optimize.BackgroundMode for this message.

setBackgroundMode

public void setBackgroundMode(Optimize.BackgroundMode value)

Set the Optimize.BackgroundMode for this message.

isCommit

public boolean isCommit()

Get if this optimize message will commit outstanding documents.

setCommit

public void setCommit(boolean value)

Set if this optimize message should commit outstanding documents.

getZones

public List<String> getZones()

Expert: Get the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

setZones

public void setZones(List<String> value)

Expert: Set the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

setZones

public void setZones(String... value)

Expert: Set the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPlatformMessage

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractPlatformMessage

clone

public Optimize clone()

Clones the object and resets message ID to -1. Clones a message. The message ID is not cloned.

Specified by:

clone in interface PlatformMessage

Specified by:

clone in interface IndexMessage

Overrides:

clone in class AbstractIndexMessage

Returns:

the cloned index message