Serialized Form (platform/sdk 5.5.1.0-SNAPSHOT API)

Package com.attivio.platform.store
- Class com.attivio.platform.store.DefaultConnectorExecutionRecord extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - clientId
```
UUID clientId
```
    - status
```
ConnectorExecutionStatus status
```
    - timestamp
```
long timestamp
```
    - startTime
```
long startTime
```
    - finishTime
```
long finishTime
```
    - documentsSent
```
long documentsSent
```
    - workflow
```
String workflow
```
    - extraRunInfo
```
List<E> extraRunInfo
```
    - external
```
boolean external
```
Package com.attivio.sdk
- Class com.attivio.sdk.AttivioException extends Exception implements Serializable
  - Serialized Fields
    - errorContext
```
String errorContext
```
    - errorCode
```
ErrorCode errorCode
```
- Class com.attivio.sdk.AttivioIOException extends IOException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
ErrorCode errorCode
```
    - errorContext
```
String errorContext
```
- Class com.attivio.sdk.AttivioRemoteException extends Exception implements Serializable
  
  serialVersionUID:
  
  -8318962896739884682L
  - Serialized Fields
    - sourceClass
```
String sourceClass
```
- Class com.attivio.sdk.AttivioRuntimeException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  -4283111836009007943L
  - Serialized Fields
    - errorCode
```
ErrorCode errorCode
```
    - errorContext
```
String errorContext
```
- Class com.attivio.sdk.TransportException extends AttivioException implements Serializable
  
  serialVersionUID:
  
  -6857290089989514267L
Package com.attivio.sdk.api
- Class com.attivio.sdk.api.ContentStoreContentPointer extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - storeName
```
String storeName
```
    - cachedSize
```
long cachedSize
```
Package com.attivio.sdk.businesscenter
- Class com.attivio.sdk.businesscenter.AdminQuery extends Object implements Serializable
  - Serialized Fields
    - query
```
String query
```
    - filters
```
List<E> filters
```
    - sort
```
List<E> sort
```
    - version
```
Set<E> version
```
    - facets
```
List<E> facets
```
- Class com.attivio.sdk.businesscenter.AdminQuery.Facet extends Object implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - maxBuckets
```
int maxBuckets
```
- Class com.attivio.sdk.businesscenter.AdminQuery.Filter extends Object implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - values
```
String[] values
```
- Class com.attivio.sdk.businesscenter.AdminQuery.Sort extends Object implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - ascending
```
boolean ascending
```
- Class com.attivio.sdk.businesscenter.AdminQueryResult extends Object implements Serializable
  - Serialized Fields
    - offset
```
long offset
```
    - totalResults
```
long totalResults
```
    - results
```
List<E> results
```
    - facets
```
List<E> facets
```
- Class com.attivio.sdk.businesscenter.AdminQueryResult.Bucket extends Object implements Serializable
  - Serialized Fields
    - label
```
String label
```
    - count
```
long count
```
- Class com.attivio.sdk.businesscenter.AdminQueryResult.FacetResult extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - buckets
```
List<E> buckets
```
Package com.attivio.sdk.client.audit
Package com.attivio.sdk.client.trigger
- Class com.attivio.sdk.client.trigger.TriggerDefinition extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - entity
```
String entity
```
    - score
```
int score
```
    - locale
```
Locale locale
```
    - query
```
Query query
```
    - compiled
```
Boolean compiled
```
    - published
```
Boolean published
```
- Class com.attivio.sdk.client.trigger.TriggerDictionaryInfo extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - schemaName
```
String schemaName
```
    - synonymDictionary
```
String synonymDictionary
```
    - triggerNameField
```
String triggerNameField
```
    - triggerScoreField
```
String triggerScoreField
```
    - entityNameField
```
String entityNameField
```
    - entityScoreField
```
String entityScoreField
```
    - triggerNameScopes
```
Boolean triggerNameScopes
```
    - entityNameScopes
```
Boolean entityNameScopes
```
    - triggerVersionField
```
String triggerVersionField
```
    - compiled
```
Boolean compiled
```
    - published
```
Boolean published
```
Package com.attivio.sdk.dictionary
- Class com.attivio.sdk.dictionary.DictionaryEntry extends DictionaryObject implements Serializable
  - Serialized Fields
    - entryId
```
String entryId
```
    - term
```
String term
```
    - payload
```
List<E> payload
```
- Class com.attivio.sdk.dictionary.DictionaryInfo extends DictionaryObject implements Serializable
  - Serialized Fields
    - locales
```
List<E> locales
```
    - dictionaryMode
```
DictionaryMode dictionaryMode
```
    - maxTermLength
```
int maxTermLength
```
    - minTermLength
```
int minTermLength
```
    - allowNumericTerms
```
boolean allowNumericTerms
```
    - minTermFrequency
```
int minTermFrequency
```
    - caseSensitive
```
boolean caseSensitive
```
    - punctuationSensitive
```
boolean punctuationSensitive
```
    - partialMatches
```
boolean partialMatches
```
    - dataSources
```
List<E> dataSources
```
    - derivedFields
```
List<E> derivedFields
```
- Class com.attivio.sdk.dictionary.DictionaryObject extends Object implements Serializable
  - Serialized Fields
    - dictionaryType
```
DictionaryType dictionaryType
```
    - dictionaryName
```
String dictionaryName
```
    - dictionaryGroup
```
String dictionaryGroup
```
    - lastModified
```
Date lastModified
```
    - lastApproved
```
Date lastApproved
```
    - lastPublished
```
Date lastPublished
```
    - version
```
RevisionStatus version
```
    - status
```
ChangeStatus status
```
    - expansionMode
```
ExpansionMode expansionMode
```
- Class com.attivio.sdk.dictionary.DictionaryPayload extends Object implements Serializable
  - Serialized Fields
    - value
```
String value
```
    - boost
```
Integer boost
```
Package com.attivio.sdk.error
- Class com.attivio.sdk.error.AdvancedTextExtractionError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  7652704612005934463L
- Class com.attivio.sdk.error.AgentError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.ApiSecurityError extends ErrorCode implements Serializable
- Class com.attivio.sdk.error.BaseTransformerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934333042656939738L
- Class com.attivio.sdk.error.BasisTechError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.BusinessCenterError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -784092246203497539L
- Class com.attivio.sdk.error.CgiApiError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.ClientError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -1316710253809842385L
- Class com.attivio.sdk.error.CommandLineError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -1248586056288880514L
- Class com.attivio.sdk.error.ConfigurationError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939731L
- Class com.attivio.sdk.error.ConnectorError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939732L
- Class com.attivio.sdk.error.ConnectorServiceError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.ContentStoreError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939732L
- Class com.attivio.sdk.error.DatabaseScannerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.DictionaryError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.ErrorCode extends Object implements Serializable
  
  serialVersionUID:
  
  8665080295894384630L
  - Serialization Methods
    - readResolve
```
protected Object readResolve()
```
      Need to implement readResolve() in order to ensure == works for serialized error codes.
      NOTE: needs to be protected to ensure all error codes use this read resolve.
  - Serialized Fields
    - category
```
String category
```
    - code
```
long code
```
- Class com.attivio.sdk.error.EventStoreError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939732L
- Class com.attivio.sdk.error.ExportStatusCode extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -915159262279363377L
- Class com.attivio.sdk.error.FederationError extends ErrorCode implements Serializable
  - Serialized Fields
    - errorMessageFmt
```
String errorMessageFmt
```
- Class com.attivio.sdk.error.HadoopCheckerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  7652704612005934463L
- Class com.attivio.sdk.error.IndexEngineError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.IndexProcessError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -236115419948206088L
- Class com.attivio.sdk.error.IndexWorkflowError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.IngestHistoryError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939732L
- Class com.attivio.sdk.error.JoinFinderError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  3835749362946692173L
  - Serialized Fields
    - msgFmt
```
String msgFmt
```
- Class com.attivio.sdk.error.KernelError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  4060379940127882834L
- Class com.attivio.sdk.error.LinguisticProcessingError extends ErrorCode implements Serializable
- Class com.attivio.sdk.error.LoadGeneratorError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.MemoryError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.MetadataError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -8113296197861630197L
- Class com.attivio.sdk.error.ModelBuildingError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3943303340256397398L
- Class com.attivio.sdk.error.OntologyError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -1316710253809842381L
- Class com.attivio.sdk.error.PerfmonServerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265937732L
- Class com.attivio.sdk.error.PlatformError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.PrincipalsError extends ErrorCode implements Serializable
- Class com.attivio.sdk.error.ProcessError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -5008267409133089785L
- Class com.attivio.sdk.error.PropertyStoreError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.QueryBuilderError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.QueryParserError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.RelevancyError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304215999738L
- Class com.attivio.sdk.error.ReplicationError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SailError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -784092246203497539L
- Class com.attivio.sdk.error.SchedulerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SchemaError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SearchClientError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SearchEngineError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SearchWorkflowError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.SecurityAdError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  4068693027563749190L
- Class com.attivio.sdk.error.SecurityError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  5686818003033882190L
- Class com.attivio.sdk.error.ServletError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -784092246203497539L
- Class com.attivio.sdk.error.SliderError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.SonarError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.SonarSpiderError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939732L
- Class com.attivio.sdk.error.SqlSdkError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  3612557204922292254L
  - Serialized Fields
    - errMessage
```
String errMessage
```
      Message associated w/ this error
- Class com.attivio.sdk.error.StoreError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.sdk.error.StructureExtractionError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -1913137660412714216L
- Class com.attivio.sdk.error.TextExtractionError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -636887444207382943L
- Class com.attivio.sdk.error.TransportError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  2007400846365575882L
- Class com.attivio.sdk.error.TriggerError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  -3934330304265939738L
- Class com.attivio.sdk.error.VisitorHistoryError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  5063789096655341629L
- Class com.attivio.sdk.error.WebServiceError extends ErrorCode implements Serializable
  
  serialVersionUID:
  
  1L
Package com.attivio.sdk.esb
- Class com.attivio.sdk.esb.AbstractListMessage extends ArrayList<T> implements Serializable
  - Serialized Fields
    - metadata
```
MessageMetadata metadata
```
    - wfQueue
```
WorkflowQueue wfQueue
```
    - history
```
List<E> history
```
    - clientId
```
UUID clientId
```
    - messageId
```
MessageId messageId
```
    - redelivered
```
boolean redelivered
```
- Class com.attivio.sdk.esb.AbstractPlatformMessage extends Object implements Serializable
  - Serialized Fields
    - messageProperties
```
MessageMetadata messageProperties
```
    - wfQueue
```
WorkflowQueue wfQueue
```
    - history
```
List<E> history
```
    - clientId
```
UUID clientId
```
    - messageId
```
MessageId messageId
```
    - redelivered
```
boolean redelivered
```
- Class com.attivio.sdk.esb.CgiRequest extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - cgiParameters
```
Map<K,V> cgiParameters
```
    - httpHeaders
```
Map<K,V> httpHeaders
```
    - inputStream
```
InputStream inputStream
```
    - method
```
String method
```
- Class com.attivio.sdk.esb.ExceptionResponse extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - cause
```
AttivioException cause
```
- Class com.attivio.sdk.esb.GroupedMessageId extends MessageId implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - groupId
```
String groupId
```
- Class com.attivio.sdk.esb.MessageHistory extends Object implements Serializable
  - Serialized Fields
    - componentName
```
String componentName
```
    - processingTime
```
long processingTime
```
    - nodeName
```
String nodeName
```
- Class com.attivio.sdk.esb.MessageId extends Object implements Serializable
  
  serialVersionUID:
  
  -5050212977917598492L
  - Serialized Fields
    - id
```
int[] id
```
    - numChildren
```
int numChildren
```
- Class com.attivio.sdk.esb.MessageList extends AbstractListMessage<PlatformMessage> implements Serializable
- Class com.attivio.sdk.esb.MessageMetadata extends BaseTypesMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  2161196500707041153L
- Class com.attivio.sdk.esb.ProcessingResult extends Object implements Serializable
  - Serialized Fields
    - clientId
```
UUID clientId
```
    - component
```
String component
```
    - docData
```
List<E> docData
```
    - msgData
```
List<E> msgData
```
- Class com.attivio.sdk.esb.ProcessingResult.Data extends Object implements Serializable
  - Serialized Fields
    - date
```
Date date
```
    - code
```
ProcessingResultCode code
```
    - errorCode
```
ErrorCode errorCode
```
    - msg
```
String msg
```
    - ex
```
Throwable ex
```
- Class com.attivio.sdk.esb.ProcessingResult.DocData extends ProcessingResult.Data implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - correlationId
```
UUID correlationId
```
    - mode
```
DocumentMode mode
```
    - parentId
```
String parentId
```
    - ancestorId
```
String ancestorId
```
- Class com.attivio.sdk.esb.ProcessingResult.MsgData extends ProcessingResult.Data implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - msgClass
```
String msgClass
```
- Class com.attivio.sdk.esb.ProcessingResultMessage extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - pr
```
ProcessingResult pr
```
- Class com.attivio.sdk.esb.PropertiesMessage extends AbstractPlatformMessage implements Serializable
- Class com.attivio.sdk.esb.StringMessage extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - str
```
String str
```
- Class com.attivio.sdk.esb.WorkflowQueue extends Object implements Serializable
  - Serialized Fields
    - workflows
```
List<E> workflows
```
    - routeImmediately
```
boolean routeImmediately
```
    - remote
```
boolean remote
```
      Indicates that the workflow queue will cause the system to route a message off node.
Package com.attivio.sdk.event
- Class com.attivio.sdk.event.EventQuery extends Object implements Serializable
  
  serialVersionUID:
  
  2174952368893240120L
  - Serialized Fields
    - subsystem
```
String subsystem
```
    - start
```
Date start
```
    - end
```
Date end
```
    - getAlreadyAcknowledged
```
boolean getAlreadyAcknowledged
```
    - maxFetchSize
```
int maxFetchSize
```
    - eventList
```
List<E> eventList
```
    - pagingContext
```
PagingContext pagingContext
```
    - done
```
boolean done
```
- Class com.attivio.sdk.event.PagingContext extends Object implements Serializable
  - Serialized Fields
    - timestamp
```
long timestamp
```
    - ids
```
HashSet<E> ids
```
- Class com.attivio.sdk.event.SystemEvent extends Object implements Serializable
  
  serialVersionUID:
  
  2719540621284261535L
  - Serialized Fields
    - severity
```
SystemEvent.Severity severity
```
    - date
```
long date
```
    - correlationId
```
String correlationId
```
    - correlationState
```
SystemEvent.CorrelationState correlationState
```
    - nodeset
```
String nodeset
```
    - acknowledgement
```
SystemEvent.Acknowledgement acknowledgement
```
    - id
```
long id
```
    - description
```
String description
```
    - subsystem
```
String subsystem
```
    - metadata
```
BaseTypesMap<K,V> metadata
```
- Class com.attivio.sdk.event.SystemEvent.Acknowledgement extends Object implements Serializable
  
  serialVersionUID:
  
  -8225617886259339677L
  - Serialized Fields
    - date
```
long date
```
    - user
```
String user
```
    - reason
```
String reason
```

Package com.attivio.sdk.geo

Class com.attivio.sdk.geo.AbstractEllipse extends Shape implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.AbstractPolygon extends Shape implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.Circle extends AbstractEllipse implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.Ellipse extends AbstractEllipse implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.Point extends Object implements Serializable
- Serialized Fields
  - x
```
double x
```
    The x coordinate value
  - y
```
double y
```
    The y coordinate value

Class com.attivio.sdk.geo.Polygon extends AbstractPolygon implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.Rectangle extends AbstractPolygon implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Class com.attivio.sdk.geo.Shape extends Object implements Serializable

Serialization Methods

readExternal

public final void readExternal(ObjectInput in)
                        throws IOException

Throws:: IOException

writeExternal

public final void writeExternal(ObjectOutput out)
                         throws IOException

Throws:: IOException

Package com.attivio.sdk.ingest
- Class com.attivio.sdk.ingest.AbstractIndexMessage extends AbstractPlatformMessage implements Serializable
- Class com.attivio.sdk.ingest.Backup extends AbstractIndexMessage implements Serializable
  - Serialized Fields
    - snapshotName
```
String snapshotName
```
- Class com.attivio.sdk.ingest.BulkUpdate extends AbstractIndexMessage implements Serializable
  - Serialized Fields
    - query
```
Query query
```
    - queryWorkflows
```
WorkflowQueue queryWorkflows
```
    - doc
```
IngestDocument doc
```
    - schemaName
```
String schemaName
```
    - groupedMessageId
```
GroupedMessageId groupedMessageId
```
    - zones
```
Set<E> zones
```
    - documentIds
```
Set<E> documentIds
```
- Class com.attivio.sdk.ingest.ByteArrayContentPointer extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - bytes
```
byte[] bytes
```
    - lastModified
```
long lastModified
```
- Class com.attivio.sdk.ingest.Commit extends AbstractIndexMessage implements Serializable
  - Serialized Fields
    - mode
```
Commit.CommitMode mode
```
    - zones
```
List<E> zones
```
- Class com.attivio.sdk.ingest.DocumentList extends AbstractListMessage<IngestDocument> implements Serializable
  
  serialVersionUID:
  
  4468057394116866329L
  - Serialized Fields
    - groupedMessageId
```
GroupedMessageId groupedMessageId
```
- Class com.attivio.sdk.ingest.IngestDocument extends Object implements Serializable
  
  serialVersionUID:
  
  5753731767017126704L
  - Serialized Fields
    - mode
```
DocumentMode mode
```
    - id
```
String id
```
    - correlationId
```
UUID correlationId
```
    - locale
```
Locale locale
```
    - acl
```
AttivioAcl acl
```
    - principal
```
AttivioPrincipal principal
```
    - groupMembership
```
AttivioGroupMembership groupMembership
```
    - fields
```
Map<K,V> fields
```
    - fieldList
```
IngestField[] fieldList
```
    - fieldCount
```
int fieldCount
```
- Class com.attivio.sdk.ingest.IngestField extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - locale
```
Locale locale
```
    - valueArray
```
IngestFieldValue[] valueArray
```
    - size
```
int size
```
- Class com.attivio.sdk.ingest.IngestFieldValue extends Object implements Serializable
  - Serialized Fields
    - value
```
Serializable value
```
    - locale
```
Locale locale
```
    - tokens
```
TokenList tokens
```
- Class com.attivio.sdk.ingest.Optimize extends AbstractIndexMessage implements Serializable
  - Serialized Fields
    - commit
```
boolean commit
```
    - mode
```
Optimize.OptimizeMode mode
```
    - backgroundMode
```
Optimize.BackgroundMode backgroundMode
```
    - zones
```
List<E> zones
```
Package com.attivio.sdk.schema
- Class com.attivio.sdk.schema.Schema extends Object implements Serializable
  
  serialVersionUID:
  
  4303160799929825829L
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
      Throws:
      
      IOException
      
      ClassNotFoundException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.schema.SchemaField extends Object implements Serializable
  
  serialVersionUID:
  
  4874518408705228106L
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
      Throws:
      
      IOException
      
      ClassNotFoundException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.schema.SchemaRequest extends AbstractPlatformMessage implements Serializable
  
  serialVersionUID:
  
  7801465307676902883L
  - Serialized Fields
    - schemaName
```
String schemaName
```
- Class com.attivio.sdk.schema.SchemaResponse extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - schema
```
Schema schema
```
- Class com.attivio.sdk.schema.UserDefinedFieldDef extends Object implements Serializable
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
      Throws:
      
      IOException
      
      ClassNotFoundException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
Package com.attivio.sdk.search
- Class com.attivio.sdk.search.FieldCollapse extends Object implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - mode
```
FieldCollapse.Mode mode
```
    - sort
```
List<E> sort
```
    - rows
```
int rows
```
    - facet
```
boolean facet
```
- Class com.attivio.sdk.search.QueryFeedback extends Object implements Serializable
  - Serialized Fields
    - messageName
```
String messageName
```
    - stageName
```
String stageName
```
    - message
```
String message
```
    - properties
```
BaseTypesMap<K,V> properties
```
- Class com.attivio.sdk.search.QueryPlacement extends Object implements Serializable
  - Serialized Fields
    - label
```
String label
```
    - linkUrl
```
String linkUrl
```
    - linkText
```
String linkText
```
    - imageUrl
```
String imageUrl
```
    - markup
```
String markup
```
- Class com.attivio.sdk.search.QueryRequest extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - rows
```
long rows
```
    - offset
```
long offset
```
    - debug
```
boolean debug
```
    - includeMetadataInResponse
```
boolean includeMetadataInResponse
```
    - query
```
Query query
```
    - filters
```
List<E> filters
```
    - facetFilters
```
List<E> facetFilters
```
    - sort
```
List<E> sort
```
    - facets
```
List<E> facets
```
    - rowFilter
```
FieldExpression rowFilter
```
      The group by specification.
    - groupBy
```
FieldExpression[] groupBy
```
    - groupByFilter
```
FieldExpression groupByFilter
```
    - fields
```
List<E> fields
```
      Selected Fields
    - boostQueries
```
List<E> boostQueries
```
      Queries to use for boosting (not matching)
    - highlight
```
boolean highlight
```
    - highlightMode
```
HighlightMode highlightMode
```
    - highlightScope
```
String highlightScope
```
    - schemaName
```
String schemaName
```
    - searchDepth
```
int searchDepth
```
    - locale
```
Locale locale
```
    - timeZone
```
TimeZone timeZone
```
    - centerTime
```
Date centerTime
```
    - spellCheckMode
```
QueryRequest.SpellCheckMode spellCheckMode
```
    - spellCheckDictionaryName
```
String spellCheckDictionaryName
```
    - synonymsMode
```
QueryRequest.SynonymsMode synonymsMode
```
    - synonymDictionaryName
```
String synonymDictionaryName
```
    - synonymBoost
```
int synonymBoost
```
    - acronymsMode
```
QueryRequest.AcronymsMode acronymsMode
```
    - acronymDictionaryName
```
String acronymDictionaryName
```
    - acronymBoost
```
int acronymBoost
```
    - stopwordsMode
```
QueryRequest.StopwordsMode stopwordsMode
```
    - stopwordDictionaryName
```
String stopwordDictionaryName
```
    - facetFinderMode
```
QueryRequest.FacetFinderMode facetFinderMode
```
    - facetFinderCount
```
int facetFinderCount
```
    - partialResults
```
boolean partialResults
```
      If true, response can be a partial response.
    - joinRollupMode
```
JoinRollupMode joinRollupMode
```
      The rollup mode for joined document summaries
    - joinFacetMode
```
JoinFacetMode joinFacetMode
```
      The facet mode for joined documents.
    - facetSampleSize
```
int facetSampleSize
```
      Sample size for sample based facets.
    - relevancyModelNames
```
String[] relevancyModelNames
```
      The name of the relevancy model to use
    - scoreFunctions
```
List<E> scoreFunctions
```
      The scoring function to use for this query
    - seed
```
long seed
```
      The random seed for use in any random functions for this query request.
    - resubmits
```
int resubmits
```
      The number of resubmits this query has done
    - maxResubmits
```
int maxResubmits
```
      The maximum number of resubmits allowed for this query
    - spellCheckExpandSize
```
int spellCheckExpandSize
```
      The number of expansions to add when spellcheck is in AUTO_EXPAND mode
    - cacheable
```
boolean cacheable
```
      Can the results of this QueryRequest be cached?
    - principal
```
AttivioPrincipal principal
```
      The principal associated with this request.
    - collapse
```
FieldCollapse collapse
```
      Field collapsing.
    - searchProfile
```
String searchProfile
```
      Search Profile Name.
    - zones
```
Set<E> zones
```
      Zones to search
    - features
```
List<E> features
```
      Relevancy features.
    - relevancyModel
```
RelevancyModel relevancyModel
```
      Model for applying relevancy features.
- Class com.attivio.sdk.search.QueryResponse extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - request
```
QueryRequest request
```
    - searchTime
```
long searchTime
```
    - facetTime
```
long facetTime
```
    - resultTime
```
long resultTime
```
    - highlightTime
```
long highlightTime
```
    - workflowTime
```
long workflowTime
```
    - facets
```
ArrayList<E> facets
```
    - feedback
```
ArrayList<E> feedback
```
    - placements
```
ArrayList<E> placements
```
    - documents
```
SearchDocumentList documents
```
    - queryTimestamp
```
long queryTimestamp
```
- Class com.attivio.sdk.search.SearchDocument extends Object implements Serializable
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
      Throws:
      
      IOException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.search.SearchDocumentList extends Object implements Serializable
  
  serialVersionUID:
  
  5475366035012296883L
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
      Throws:
      
      IOException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.search.SearchField extends Object implements Serializable
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
      Throws:
      
      IOException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.search.SearchFieldValue extends Object implements Serializable
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
      Throws:
      
      IOException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.search.Sort extends Object implements Serializable
  - Serialized Fields
    - field
```
FieldExpression field
```
      The field being sorted on.
    - order
```
Sort.SortOrder order
```
      The sort order
    - nullOrder
```
Sort.NullSortOrder nullOrder
```
      The null sort order
Package com.attivio.sdk.search.facet
- Class com.attivio.sdk.search.facet.DateFacetRequest extends FacetRequest implements Serializable
  - Serialized Fields
    - intervals
```
List<E> intervals
```
- Class com.attivio.sdk.search.facet.DateFacetRequest.DateFacetInterval extends Object implements Serializable
  - Serialized Fields
    - resolution
```
DateFacetRequest.DateFacetResolution resolution
```
    - step
```
int step
```
- Class com.attivio.sdk.search.facet.FacetBucket extends Object implements Serializable
  
  serialVersionUID:
  
  -2463403687371520118L
  - Serialized Fields
    - count
```
long count
```
      The count
- Class com.attivio.sdk.search.facet.FacetFilter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - label
```
String label
```
    - filter
```
Query filter
```
- Class com.attivio.sdk.search.facet.FacetRange extends Object implements Serializable
  - Serialized Fields
    - label
```
String label
```
    - minValue
```
Object minValue
```
    - maxValue
```
Object maxValue
```
- Class com.attivio.sdk.search.facet.FacetRequest extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name for this FacetRequest.
    - field
```
FieldExpression field
```
      The field name for this FacetRequest
    - shallowMode
```
ShallowMode shallowMode
```
      Sample mode for generating a facet.
    - maxNumBuckets
```
Integer maxNumBuckets
```
      The maximum number of buckets for this FacetRequest to return
    - minCutoff
```
Integer minCutoff
```
      The minimum bucket count for buckets returned by this FacetRequest.
    - distMinCutoff
```
Integer distMinCutoff
```
      The minimum bucket count for buckets returned from sub-dispatchers for this FacetRequest
    - distMaxNumBuckets
```
Integer distMaxNumBuckets
```
      The maximum number of buckets to return from sub-dispatchers for this FacetRequest
    - maxMemoryUsage
```
long maxMemoryUsage
```
    - sortBy
```
FacetRequest.SortBy sortBy
```
      What field of the bucket to sort by
    - primarySort
```
Sort.SortOrder primarySort
```
      Sort order for field specified by sortBy
    - secondarySort
```
Sort.SortOrder secondarySort
```
      Sort order for breaking ties in primary sort
    - calculateStatistics
```
boolean calculateStatistics
```
      If true, statistics will be calculated for response.
    - facetFinder
```
boolean facetFinder
```
      Can facet finder replace this request?
    - facetTokens
```
boolean facetTokens
```
- Class com.attivio.sdk.search.facet.FacetResponse extends Object implements Serializable
  
  serialVersionUID:
  
  -3914688421606058608L
  - Serialized Fields
    - name
```
String name
```
    - field
```
String field
```
    - displayName
```
String displayName
```
    - facetTime
```
long facetTime
```
    - totalCount
```
long totalCount
```
    - statistics
```
FacetStatistics statistics
```
    - buckets
```
ArrayList<E> buckets
```
    - attributes
```
BaseTypesMap<K,V> attributes
```
- Class com.attivio.sdk.search.facet.FacetStatistics extends Object implements Serializable
  - Serialized Fields
    - count
```
long count
```
      The number of unique values represented by the facet.
    - sum
```
double sum
```
    - sumOfSquares
```
double sumOfSquares
```
    - min
```
Number min
```
    - max
```
Number max
```
- Class com.attivio.sdk.search.facet.FilterBasedFacetRequest extends FacetRequest implements Serializable
  - Serialized Fields
    - filters
```
LinkedHashMap<K,V> filters
```
- Class com.attivio.sdk.search.facet.QueryFacetBucket extends FacetBucket implements Serializable
  - Serialized Fields
    - label
```
String label
```
    - ordinal
```
int ordinal
```
    - filter
```
Query filter
```
- Class com.attivio.sdk.search.facet.RangeFacetBucket extends FacetBucket implements Serializable
  - Serialized Fields
    - ordinal
```
int ordinal
```
    - range
```
FacetRange range
```
- Class com.attivio.sdk.search.facet.RangeFacetRequest extends FacetRequest implements Serializable
  - Serialized Fields
    - ranges
```
ArrayList<E> ranges
```
      The ranges being requested
- Class com.attivio.sdk.search.facet.SchemaFacetRequest extends FacetRequest implements Serializable
  - Serialized Fields
    - storedFields
```
boolean storedFields
```
    - facetFields
```
boolean facetFields
```
    - indexedFields
```
boolean indexedFields
```
    - sortFields
```
boolean sortFields
```
    - realTimeFields
```
boolean realTimeFields
```
    - fields
```
Set<E> fields
```
    - countBuckets
```
boolean countBuckets
```
    - countValues
```
boolean countValues
```
    - types
```
List<E> types
```
- Class com.attivio.sdk.search.facet.SchemaFieldBucket extends FacetBucket implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - values
```
long values
```
- Class com.attivio.sdk.search.facet.ScopeFacetRequest extends FacetRequest implements Serializable
  - Serialized Fields
    - scope
```
String scope
```
    - caseMode
```
ScopeFacetRequest.CaseMode caseMode
```
- Class com.attivio.sdk.search.facet.TermFacetBucket extends FacetBucket implements Serializable
  - Serialized Fields
    - value
```
Object value
```
      The value for this bucket
Package com.attivio.sdk.search.fields
- Class com.attivio.sdk.search.fields.AggregateExpression extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - method
```
AggregateExpression.Method method
```
      The aggregate function to compute.
- Class com.attivio.sdk.search.fields.BinaryFieldExpression extends FieldExpression implements Serializable
  - Serialized Fields
    - arg0
```
FieldExpression arg0
```
      The First argument
    - arg1
```
FieldExpression arg1
```
      The Second argument
- Class com.attivio.sdk.search.fields.BinaryMathExpression extends BinaryFieldExpression implements Serializable
  - Serialized Fields
    - method
```
BinaryMathExpression.Method method
```
      The aggregate function to compute.
    - multiValueMode
```
MultiValueMode multiValueMode
```
      The multi-value mode.
- Class com.attivio.sdk.search.fields.BooleanExpression extends MultiaryFieldExpression implements Serializable
  - Serialized Fields
    - op
```
BooleanExpression.Operator op
```
- Class com.attivio.sdk.search.fields.Cast extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - type
```
SchemaField.Type type
```
      The type to cast to
    - dateResolution
```
TimeResolution dateResolution
```
    - scale
```
int scale
```
- Class com.attivio.sdk.search.fields.ClauseContext extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - clause
```
String clause
```
- Class com.attivio.sdk.search.fields.Coalesce extends MultiaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.Collate extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - strength
```
Collate.Strength strength
```
    - decomposition
```
Collate.Decomposition decomposition
```
- Class com.attivio.sdk.search.fields.Compare extends BinaryFieldExpression implements Serializable
  - Serialized Fields
    - op
```
Compare.Operator op
```
- Class com.attivio.sdk.search.fields.Concat extends MultiaryFieldExpression implements Serializable
  - Serialized Fields
    - multiValueMode
```
MultiValueMode multiValueMode
```
- Class com.attivio.sdk.search.fields.Condition extends FieldExpression implements Serializable
  - Serialized Fields
    - condition
```
FieldExpression condition
```
    - trueValue
```
FieldExpression trueValue
```
      The First argument
    - falseValue
```
FieldExpression falseValue
```
      The Second argument
- Class com.attivio.sdk.search.fields.Constant extends FieldExpression implements Serializable
  - Serialized Fields
    - value
```
Object value
```
- Class com.attivio.sdk.search.fields.CurrentTime extends FieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.DateAdd extends BinaryFieldExpression implements Serializable
  - Serialized Fields
    - field
```
CalendarField field
```
      The calendar field requested.
- Class com.attivio.sdk.search.fields.DateDiff extends BinaryFieldExpression implements Serializable
  - Serialized Fields
    - field
```
CalendarField field
```
      The calendar field requested.
- Class com.attivio.sdk.search.fields.DateExtract extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - field
```
CalendarField field
```
      The calendar field requested.
- Class com.attivio.sdk.search.fields.DateFormat extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - format
```
String format
```
- Class com.attivio.sdk.search.fields.DocBoost extends FieldExpression implements Serializable
  - Serialized Fields
    - ids
```
String[] ids
```
- Class com.attivio.sdk.search.fields.FieldExpression extends Object implements Serializable
  - Serialized Fields
    - alias
```
String alias
```
      The alias for this expression.
- Class com.attivio.sdk.search.fields.FieldLength extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
- Class com.attivio.sdk.search.fields.Freshness extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - decay
```
double decay
```
    - defaultValue
```
Date defaultValue
```
    - center
```
Date center
```
    - centerResolution
```
TimeResolution centerResolution
```
    - ranges
```
ArrayList<E> ranges
```
- Class com.attivio.sdk.search.fields.FreshnessRange extends Object implements Serializable
  - Serialized Fields
    - timeUnit
```
TimeResolution timeUnit
```
    - maxDelta
```
long maxDelta
```
    - a
```
double a
```
    - b
```
double b
```
    - c
```
double c
```
- Class com.attivio.sdk.search.fields.GeoBoost extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - latitude
```
double latitude
```
    - longitude
```
double longitude
```
- Class com.attivio.sdk.search.fields.GeoDistance extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - latitude
```
double latitude
```
    - longitude
```
double longitude
```
    - distanceUnits
```
DistanceUnits distanceUnits
```
- Class com.attivio.sdk.search.fields.Locate extends FieldExpression implements Serializable
  - Serialized Fields
    - search
```
FieldExpression search
```
    - string
```
FieldExpression string
```
    - startPosition
```
FieldExpression startPosition
```
- Class com.attivio.sdk.search.fields.LowerCase extends UnaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.MatchingFields extends FieldExpression implements Serializable
  - Serialized Fields
    - label
```
String label
```
- Class com.attivio.sdk.search.fields.MatchingTerms extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
    - scope
```
String scope
```
- Class com.attivio.sdk.search.fields.MultiaryFieldExpression extends FieldExpression implements Serializable
  
  serialVersionUID:
  
  -5556598026230593131L
  - Serialized Fields
    - args
```
FieldExpression[] args
```
- Class com.attivio.sdk.search.fields.MultiValueJoin extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - delimiter
```
String delimiter
```
- Class com.attivio.sdk.search.fields.NumDocs extends FieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.PartitionId extends FieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.PhraseMatch extends com.attivio.sdk.search.fields.PhraseExpression implements Serializable
- Class com.attivio.sdk.search.fields.PhraseScore extends com.attivio.sdk.search.fields.PhraseExpression implements Serializable
  - Serialized Fields
    - scoreMode
```
ScoreMode scoreMode
```
- Class com.attivio.sdk.search.fields.QueryParameter extends FieldExpression implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - defaultValue
```
Constant defaultValue
```
- Class com.attivio.sdk.search.fields.RegexMatch extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - pattern
```
String pattern
```
- Class com.attivio.sdk.search.fields.ScopeField extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
    - scope
```
String scope
```
    - mode
```
HighlightMode mode
```
- Class com.attivio.sdk.search.fields.ScopeFrequency extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
    - scope
```
String scope
```
- Class com.attivio.sdk.search.fields.ScopeTeaser extends Teaser implements Serializable
- Class com.attivio.sdk.search.fields.ScoreExplain extends FieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.StandardScore extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - mean
```
double mean
```
    - stdev
```
double stdev
```
- Class com.attivio.sdk.search.fields.StoredField extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
- Class com.attivio.sdk.search.fields.StringLength extends UnaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.SubString extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - offset
```
int offset
```
    - length
```
int length
```
- Class com.attivio.sdk.search.fields.Switch extends FieldExpression implements Serializable
  - Serialized Fields
    - input
```
FieldExpression input
```
    - cases
```
List<E> cases
```
    - defaultOutput
```
FieldExpression defaultOutput
```
- Class com.attivio.sdk.search.fields.Switch.Case extends Object implements Serializable
  - Serialized Fields
    - condition
```
FieldExpression condition
```
    - output
```
FieldExpression output
```
- Class com.attivio.sdk.search.fields.Teaser extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - fallbackField
```
String fallbackField
```
    - fragment
```
Boolean fragment
```
    - mergeFragments
```
Boolean mergeFragments
```
    - numFragments
```
Integer numFragments
```
    - fragmentSize
```
Integer fragmentSize
```
    - highlightScope
```
String highlightScope
```
    - separator
```
String separator
```
    - tokenizer
```
String tokenizer
```
    - fragmentScope
```
String fragmentScope
```
    - highlightMode
```
HighlightMode highlightMode
```
    - matchScope
```
String matchScope
```
    - whitelist
```
String[] whitelist
```
    - query
```
Query query
```
- Class com.attivio.sdk.search.fields.TitleCase extends UnaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.TotalScopeFrequency extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
    - scope
```
String scope
```
- Class com.attivio.sdk.search.fields.TotalTermFrequency extends FieldExpression implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
- Class com.attivio.sdk.search.fields.Trim extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - mode
```
Trim.Mode mode
```
    - remstr
```
String remstr
```
- Class com.attivio.sdk.search.fields.UnaryFieldExpression extends FieldExpression implements Serializable
  - Serialized Fields
    - expression
```
FieldExpression expression
```
      The expression that is the argument to this expression.
- Class com.attivio.sdk.search.fields.UnaryMathExpression extends UnaryFieldExpression implements Serializable
  - Serialized Fields
    - method
```
UnaryMathExpression.Method method
```
      The aggregate function to compute.
- Class com.attivio.sdk.search.fields.Union extends MultiaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.UpperCase extends UnaryFieldExpression implements Serializable
- Class com.attivio.sdk.search.fields.UserDefinedField extends FieldExpression implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - args
```
FieldExpression[] args
```
    - size
```
int size
```
    - parameters
```
Map<K,V> parameters
```
Package com.attivio.sdk.search.query
- Class com.attivio.sdk.search.query.AccessControlQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
  - Serialized Fields
    - principal
```
Query principal
```
    - acls
```
Query acls
```
    - acl
```
String acl
```
    - idField
```
String idField
```
    - aclField
```
String aclField
```
    - allowField
```
String allowField
```
    - denyField
```
String denyField
```
    - anonymousAcl
```
String anonymousAcl
```
    - unsecuredZones
```
List<E> unsecuredZones
```
- Class com.attivio.sdk.search.query.BooleanAndQuery extends com.attivio.sdk.search.query.AbstractBooleanQuery implements Serializable
- Class com.attivio.sdk.search.query.BooleanNotQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
- Class com.attivio.sdk.search.query.BooleanOrQuery extends com.attivio.sdk.search.query.AbstractBooleanQuery implements Serializable
- Class com.attivio.sdk.search.query.BoostQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
  - Serialized Fields
    - boostQuery
```
Query boostQuery
```
    - scoreFunctions
```
List<E> scoreFunctions
```
- Class com.attivio.sdk.search.query.CompositeJoinQuery extends Query implements Serializable
  - Serialized Fields
    - query
```
Query query
```
    - fromQuery
```
Query fromQuery
```
    - field
```
String field
```
    - clauses
```
List<E> clauses
```
- Class com.attivio.sdk.search.query.CompositeJoinQuery.Clause extends com.attivio.sdk.search.query.AbstractJoinClause implements Serializable
  - Serialized Fields
    - foreignKey
```
String foreignKey
```
    - required
```
boolean required
```
- Class com.attivio.sdk.search.query.FacetQuery extends Query implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - term
```
PhraseTerm term
```
- Class com.attivio.sdk.search.query.FieldExpressionQuery extends Query implements Serializable
  - Serialized Fields
    - field
```
FieldExpression field
```
- Class com.attivio.sdk.search.query.FilterQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
  - Serialized Fields
    - filter
```
Query filter
```
- Class com.attivio.sdk.search.query.GeoDistanceQuery extends Query implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - center
```
Point center
```
    - distance
```
double distance
```
    - distanceUnits
```
DistanceUnits distanceUnits
```
- Class com.attivio.sdk.search.query.GraphQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
  - Serialized Fields
    - linkField
```
String linkField
```
    - idField
```
String idField
```
- Class com.attivio.sdk.search.query.JoinClause extends com.attivio.sdk.search.query.AbstractJoinClause implements Serializable
  - Serialized Fields
    - mode
```
JoinMode mode
```
    - order
```
Sort order
```
    - primaryKey
```
String primaryKey
```
    - foreignKey
```
String foreignKey
```
    - joinConstraint
```
FieldExpression joinConstraint
```
- Class com.attivio.sdk.search.query.JoinQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
  - Serialized Fields
    - clauses
```
List<E> clauses
```
      List of all joined queries
- Class com.attivio.sdk.search.query.PhraseQuery extends Query implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - phrase
```
Phrase phrase
```
- Class com.attivio.sdk.search.query.Query extends com.attivio.sdk.search.query.QueryComponent implements Serializable
  - Serialized Fields
    - boost
```
int boost
```
- Class com.attivio.sdk.search.query.QueryComponent.Parameter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - value
```
Object value
```
    - next
```
QueryComponent.Parameter next
```
- Class com.attivio.sdk.search.query.QueryPlugin extends Query implements Serializable
  - Serialized Fields
    - name
```
String name
```
- Class com.attivio.sdk.search.query.QueryString extends Query implements Serializable
  - Serialized Fields
    - query
```
String query
```
- Class com.attivio.sdk.search.query.SavedFilter extends Query implements Serializable
  - Serialized Fields
    - contentPointerUri
```
String contentPointerUri
```
    - uuid
```
String uuid
```
- Class com.attivio.sdk.search.query.ShapeQuery extends Query implements Serializable
  - Serialized Fields
    - field
```
String field
```
    - shape
```
Shape shape
```
- Class com.attivio.sdk.search.query.SubQuery extends com.attivio.sdk.search.query.AbstractFilterQuery implements Serializable
Package com.attivio.sdk.search.query.phrase
- Class com.attivio.sdk.search.query.phrase.AnchorFilter extends Phrase implements Serializable
  - Serialized Fields
    - phrase
```
Phrase phrase
```
    - mode
```
AnchorFilter.AnchorMode mode
```
- Class com.attivio.sdk.search.query.phrase.FuzzyTerm extends PhraseTerm implements Serializable
  - Serialized Fields
    - text
```
String text
```
    - similarity
```
int similarity
```
    - prefixLength
```
int prefixLength
```
- Class com.attivio.sdk.search.query.phrase.Phrase extends Object implements Serializable
  - Serialized Fields
    - parameters
```
Phrase.Parameter parameters
```
    - boost
```
int boost
```
- Class com.attivio.sdk.search.query.phrase.Phrase.Parameter extends Object implements Serializable
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
```
      Throws:
      
      IOException
      
      ClassNotFoundException
    - writeExternal
```
public void writeExternal(ObjectOutput output)
                   throws IOException
```
      Throws:
      
      IOException
- Class com.attivio.sdk.search.query.phrase.PhraseNear extends com.attivio.sdk.search.query.phrase.MultiTermPhrase implements Serializable
  - Serialized Fields
    - ordered
```
boolean ordered
```
    - distance
```
int distance
```
    - minimum
```
int minimum
```
- Class com.attivio.sdk.search.query.phrase.PhraseNot extends Phrase implements Serializable
  - Serialized Fields
    - includePhrase
```
Phrase includePhrase
```
    - excludePhrase
```
Phrase excludePhrase
```
- Class com.attivio.sdk.search.query.phrase.PhraseNotIn extends Phrase implements Serializable
  - Serialized Fields
    - includePhrase
```
Phrase includePhrase
```
    - excludePhrase
```
Phrase excludePhrase
```
- Class com.attivio.sdk.search.query.phrase.PhraseOr extends com.attivio.sdk.search.query.phrase.MultiTermPhrase implements Serializable
- Class com.attivio.sdk.search.query.phrase.PhraseTerm extends Phrase implements Serializable
  - Serialized Fields
    - startOffset
```
int startOffset
```
    - endOffset
```
int endOffset
```
    - annotations
```
long annotations
```
      Arbitrary token annotations.
- Class com.attivio.sdk.search.query.phrase.RegexTerm extends PhraseTerm implements Serializable
  - Serialized Fields
    - text
```
String text
```
- Class com.attivio.sdk.search.query.phrase.ScopeBoost extends Phrase implements Serializable
  - Serialized Fields
    - phrase
```
Phrase phrase
```
    - scope
```
Phrase scope
```
    - completenessBoost
```
int completenessBoost
```
- Class com.attivio.sdk.search.query.phrase.ScopeFilter extends Phrase implements Serializable
  - Serialized Fields
    - scope
```
String scope
```
    - phrase
```
Phrase phrase
```
- Class com.attivio.sdk.search.query.phrase.ScopeTerm extends Phrase implements Serializable
  - Serialized Fields
    - text
```
String text
```
- Class com.attivio.sdk.search.query.phrase.SearchTerm extends PhraseTerm implements Serializable
  - Serialized Fields
    - text
```
String text
```
- Class com.attivio.sdk.search.query.phrase.TermRange extends PhraseTerm implements Serializable
  - Serialized Fields
    - lowerTerm
```
String lowerTerm
```
    - upperTerm
```
String upperTerm
```
    - includeLower
```
boolean includeLower
```
    - includeUpper
```
boolean includeUpper
```
- Class com.attivio.sdk.search.query.phrase.WildcardTerm extends PhraseTerm implements Serializable
  - Serialized Fields
    - text
```
String text
```
Package com.attivio.sdk.search.relevancy
- Class com.attivio.sdk.search.relevancy.CategoryBoostFeature extends RelevancyFeatureDef implements Serializable
  - Serialized Fields
    - field
```
FieldExpression field
```
- Class com.attivio.sdk.search.relevancy.FieldBoostFeature extends RelevancyFeatureDef implements Serializable
  - Serialized Fields
    - field
```
FieldExpression field
```
- Class com.attivio.sdk.search.relevancy.PhraseBoostFeature extends com.attivio.sdk.search.relevancy.QueryBoostFeature implements Serializable
  - Serialized Fields
    - minimum
```
int minimum
```
    - distance
```
int distance
```
    - ordered
```
boolean ordered
```
    - completeness
```
boolean completeness
```
    - scopeBoosts
```
List<E> scopeBoosts
```
    - scope
```
String scope
```
- Class com.attivio.sdk.search.relevancy.PhraseBoostFeature.ScopeBoost extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - boost
```
int boost
```
    - completeness
```
int completeness
```
- Class com.attivio.sdk.search.relevancy.RelevancyFeature extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - field
```
FieldExpression field
```
    - categorical
```
boolean categorical
```
- Class com.attivio.sdk.search.relevancy.RelevancyFeatureDef extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
- Class com.attivio.sdk.search.relevancy.RelevancyFeatureVector extends Object implements Serializable
  - Serialized Fields
    - names
```
String[] names
```
    - values
```
float[] values
```
    - size
```
int size
```
- Class com.attivio.sdk.search.relevancy.RelevancyModel extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - source
```
RelevancyModel.Source source
```
    - version
```
long version
```
    - lastModified
```
long lastModified
```
    - weights
```
List<E> weights
```
    - options
```
Map<K,V> options
```
    - signalTypes
```
Set<E> signalTypes
```
    - featureWhitelist
```
Set<E> featureWhitelist
```
    - featureBlacklist
```
Set<E> featureBlacklist
```
    - maxSignalAge
```
long maxSignalAge
```
    - maxHistory
```
int maxHistory
```
    - publishThreshold
```
double publishThreshold
```
    - accuracy
```
double accuracy
```
- Class com.attivio.sdk.search.relevancy.RelevancyModel.FeatureWeight extends Object implements Serializable
  - Serialized Fields
    - feature
```
String feature
```
    - weight
```
float weight
```
- Class com.attivio.sdk.search.relevancy.Signal extends Object implements Serializable
  - Serialized Fields
    - principal
```
AttivioPrincipal principal
```
    - docId
```
String docId
```
    - docOrdinal
```
long docOrdinal
```
    - featureVector
```
RelevancyFeatureVector featureVector
```
    - query
```
String query
```
    - locale
```
Locale locale
```
    - relevancyModelName
```
String relevancyModelName
```
    - relevancyModelVersion
```
long relevancyModelVersion
```
    - relevancyModelNames
```
String[] relevancyModelNames
```
    - queryTimestamp
```
long queryTimestamp
```
    - signalTimestamp
```
long signalTimestamp
```
    - type
```
String type
```
    - weight
```
double weight
```
    - ttl
```
boolean ttl
```
- Class com.attivio.sdk.search.relevancy.TermBoostFeature extends com.attivio.sdk.search.relevancy.QueryBoostFeature implements Serializable
Package com.attivio.sdk.security
- Class com.attivio.sdk.security.AttivioAcl extends Object implements Serializable
  
  serialVersionUID:
  
  -4398350239815785149L
  - Serialized Fields
    - aclName
```
String aclName
```
    - entries
```
Set<E> entries
```
- Class com.attivio.sdk.security.AttivioAclEntry extends Object implements Serializable
  
  serialVersionUID:
  
  3542379487901588003L
  - Serialized Fields
    - principal
```
AttivioPrincipal principal
```
    - permissions
```
List<E> permissions
```
    - idx
```
int idx
```
    - isNegative
```
boolean isNegative
```
- Class com.attivio.sdk.security.AttivioGroupMembership extends Object implements Serializable
  - Serialized Fields
    - principalKey
```
AttivioPrincipalKey principalKey
```
      The subject (group member) key.
    - groupKey
```
AttivioPrincipalKey groupKey
```
      The object (group) key.
- Class com.attivio.sdk.security.AttivioPermission extends Object implements Serializable
  
  serialVersionUID:
  
  3266053110760079660L
  - Serialized Fields
    - permissionType
```
String permissionType
```
- Class com.attivio.sdk.security.AttivioPrincipal extends Object implements Serializable
  
  serialVersionUID:
  
  -1580170461862780369L
  - Serialized Fields
    - realmId
```
String realmId
```
      The security realm ID.
    - principalId
```
String principalId
```
      The principal ID.
    - principalName
```
String principalName
```
      The principal name.
    - principalType
```
AttivioPrincipal.PrincipalType principalType
```
      The principal type.
    - roles
```
Set<E> roles
```
      Optional roles used by the Security Client API authorization.
    - groupMemberships
```
Set<E> groupMemberships
```
      Any group memberships of this principal.
    - correlationId
```
UUID correlationId
```
      correlation id if set
    - properties
```
BaseTypesMap<K,V> properties
```
      Any additional properties.
    - password
```
String password
```
- Class com.attivio.sdk.security.AttivioPrincipalAlias extends AttivioGroupMembership implements Serializable
- Class com.attivio.sdk.security.AttivioPrincipalKey extends Object implements Serializable
  - Serialized Fields
    - realmId
```
String realmId
```
    - principalId
```
String principalId
```
- Class com.attivio.sdk.security.AttivioRole extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
    - subgroup
```
String subgroup
```
- Class com.attivio.sdk.security.AuthenticationRequest extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - uername
```
String uername
```
    - password
```
String password
```
- Class com.attivio.sdk.security.AuthenticationResponse extends AbstractPlatformMessage implements Serializable
  - Serialized Fields
    - attivioPrincipal
```
AttivioPrincipal attivioPrincipal
```
Package com.attivio.sdk.service
- Class com.attivio.sdk.service.MockContentStoreClient.MemoryContentPointer extends Object implements Serializable
  - Serialized Fields
    - bytes
```
byte[] bytes
```
    - id
```
String id
```
    - modified
```
long modified
```
- Class com.attivio.sdk.service.MockContentStoreProvider.MemoryContentPointer extends Object implements Serializable
  - Serialized Fields
    - bytes
```
byte[] bytes
```
    - id
```
String id
```
    - modified
```
long modified
```
- Class com.attivio.sdk.service.MockIngestApi.MockAuditDetail extends Object implements Serializable
  - Serialized Fields
    - seq
```
long seq
```
    - date
```
Date date
```
    - clientId
```
UUID clientId
```
    - id
```
String id
```
    - msgClass
```
String msgClass
```
    - code
```
ProcessingResultCode code
```
    - node
```
String node
```
    - correlationId
```
UUID correlationId
```
    - docMode
```
DocumentMode docMode
```
    - component
```
String component
```
    - parent
```
String parent
```
    - ancestor
```
String ancestor
```
- Class com.attivio.sdk.service.ServiceFactoryFactory.ServiceFactoryError extends ErrorCode implements Serializable
Package com.attivio.sdk.token
- Class com.attivio.sdk.token.Token extends Object implements Serializable
  - Serialized Fields
    - text
```
String text
```
      The character data for this token
    - startOffset
```
int startOffset
```
      The start offset in the source text
    - endOffset
```
int endOffset
```
      The start offset in the source text
    - annotations
```
long annotations
```
      The annotations associated with this Token (as a bit set)
- Class com.attivio.sdk.token.TokenList extends TokenSink implements Serializable
  
  serialVersionUID:
  
  -7537436873450206778L
  - Serialization Methods
    - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException
```
      Throws:
      
      IOException
    - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
      Throws:
      
      IOException
Package com.attivio.sdk.util
- Class com.attivio.sdk.util.BaseTypesList extends ArrayList<E> implements Serializable
  
  serialVersionUID:
  
  -5599633523960236283L
- Class com.attivio.sdk.util.BaseTypesMap extends LinkedHashMap<K,V> implements Serializable
  
  serialVersionUID:
  
  -8255820696447235048L
- Class com.attivio.sdk.util.ContainerPropertyReference extends Object implements Serializable
  
  serialVersionUID:
  
  2522459533783726219L
  - Serialized Fields
    - name
```
String name
```
- Class com.attivio.sdk.util.PropertyMap extends BaseTypesMap<String,Object> implements Serializable
Package com.attivio.service
- Class com.attivio.service.NoDeployedProjectException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  -7034897190745766939L
Package com.attivio.util
- Class com.attivio.util.BlockedExitException extends SecurityException implements Serializable
  - Serialized Fields
    - exitCode
```
int exitCode
```
- Class com.attivio.util.ConcurrentHashSet extends ConcurrentSkipListSet<E> implements Serializable
- Class com.attivio.util.FileUtils.FileNameComparator extends Object implements Serializable
  
  serialVersionUID:
  
  -8111728458013780791L
- Class com.attivio.util.InverseMapEntryComparator extends Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.attivio.util.MultiValueMap extends Object implements Serializable
  - Serialized Fields
    - m
```
Map<K,V> m
```
- Class com.attivio.util.RemoteEndpoint extends Object implements Serializable
  
  serialVersionUID:
  
  -2852902550977719781L
  - Serialized Fields
    - url
```
String url
```
    - username
```
String username
```
    - password
```
String password
```

Serialized Form

Package com.attivio.platform.store

Class com.attivio.platform.store.DefaultConnectorExecutionRecord extends Object implements Serializable

Serialized Fields

name

clientId

status

timestamp

startTime

finishTime

documentsSent

workflow

extraRunInfo

external

Package com.attivio.sdk

Class com.attivio.sdk.AttivioException extends Exception implements Serializable

Serialized Fields

errorContext

errorCode

Class com.attivio.sdk.AttivioIOException extends IOException implements Serializable

Serialized Fields

errorCode

errorContext

Class com.attivio.sdk.AttivioRemoteException extends Exception implements Serializable

Serialized Fields

sourceClass

Class com.attivio.sdk.AttivioRuntimeException extends RuntimeException implements Serializable

Serialized Fields

errorCode

errorContext

Class com.attivio.sdk.TransportException extends AttivioException implements Serializable

Package com.attivio.sdk.api

Class com.attivio.sdk.api.ContentStoreContentPointer extends Object implements Serializable

Serialized Fields

id

storeName

cachedSize

Package com.attivio.sdk.businesscenter

Class com.attivio.sdk.businesscenter.AdminQuery extends Object implements Serializable

Serialized Fields

query

filters

sort

version

facets

Class com.attivio.sdk.businesscenter.AdminQuery.Facet extends Object implements Serializable

Serialized Fields

field

maxBuckets

Class com.attivio.sdk.businesscenter.AdminQuery.Filter extends Object implements Serializable

Serialized Fields

field

values

Class com.attivio.sdk.businesscenter.AdminQuery.Sort extends Object implements Serializable

Serialized Fields

field

ascending

Class com.attivio.sdk.businesscenter.AdminQueryResult extends Object implements Serializable

Serialized Fields

offset

totalResults

results

facets

Class com.attivio.sdk.businesscenter.AdminQueryResult.Bucket extends Object implements Serializable

Serialized Fields

label

count

Class com.attivio.sdk.businesscenter.AdminQueryResult.FacetResult extends Object implements Serializable

Serialized Fields

name

buckets

Package com.attivio.sdk.client.audit

Package com.attivio.sdk.client.trigger

Class com.attivio.sdk.client.trigger.TriggerDefinition extends Object implements Serializable

Serialized Fields

name

entity

score

locale

query