com.attivio.sdk.ingest

Class Backup

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.ingest.AbstractIndexMessage

com.attivio.sdk.ingest.Backup

All Implemented Interfaces:

PlatformMessage, IndexMessage, Serializable, Cloneable

public class Backup
extends AbstractIndexMessage

Message used to initiate an index backup.

See Also:

Serialized Form

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
Backup() The default constructor
Backup(UUID cid, String... workflows) Constructor with a client ID and an array of workflows
Backup(UUID cid, WorkflowQueue workflows) Constructor with a client ID and a workflow queue

Method Summary

Modifier and Type	Method and Description
Backup	clone() Clones the object and resets message ID to -1.
boolean	equals(Object other)
String	getSnapshotName() Get the name of the snapshot that should be created.
int	hashCode()
void	setSnapshotName(String value) Set the name of the snapshot that should be created.

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

Backup

public Backup()

The default constructor

Backup

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

Constructor with a client ID and an array of workflows

Parameters:

cid - the client ID

workflows - the workflows

Backup

public Backup(UUID cid,
              WorkflowQueue workflows)

Constructor with a client ID and a workflow queue

Method Detail

getSnapshotName

public String getSnapshotName()

Get the name of the snapshot that should be created.

If no name is specified, a name will be automatically selected as needed if applicable.

setSnapshotName

public void setSnapshotName(String value)

Set the name of the snapshot that should be created.

If no name is specified, a name will be automatically selected as needed if applicable.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPlatformMessage

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractPlatformMessage

clone

public Backup 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