com.textkernel.tx.models.api.indexes

Class IndexingOptionsGeneric

java.lang.Object

com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric

Direct Known Subclasses:

IndexJobInfo, IndexResumeInfo

public class IndexingOptionsGeneric
extends Object

Generic options that have properties for both V1 and V2.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,String>	CustomFields A key-value collection of custom fields.
String	DocumentId The id to assign to the new document.
String	IndexId The id for the index where the document should be added (case-insensitive).
List<String>	Roles The list of roles that are allowed to retrieve the document.
MatchV2Environment	SearchAndMatchEnvironment The target environment where the document will be uploaded
SearchAndMatchVersion	SearchAndMatchVersion The Search & Match Version to use for indexing.
List<String>	UserDefinedTags The user-defined tags the document should have

Constructor Summary

Constructors

Constructor and Description
IndexingOptionsGeneric(MatchV2Environment env, String documentId, List<String> roles, Map<String,String> customFields) Create options to upload a document with Match V2
IndexingOptionsGeneric(String documentId, String indexId, List<String> userDefinedTags) Create options to index a document with Match V1

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SearchAndMatchVersion

public SearchAndMatchVersion SearchAndMatchVersion

The Search & Match Version to use for indexing.

DocumentId

public String DocumentId

The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

IndexId

public String IndexId

The id for the index where the document should be added (case-insensitive).

Only use when SearchAndMatchVersion = SearchAndMatchVersion.V1

UserDefinedTags

public List<String> UserDefinedTags

The user-defined tags the document should have

Only use when SearchAndMatchVersion = SearchAndMatchVersion.V1

SearchAndMatchEnvironment

public MatchV2Environment SearchAndMatchEnvironment

The target environment where the document will be uploaded

Only use when SearchAndMatchVersion = SearchAndMatchVersion.V2

Roles

public List<String> Roles

The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used.

Only use when SearchAndMatchVersion = SearchAndMatchVersion.V2

CustomFields

public Map<String,String> CustomFields

A key-value collection of custom fields.

Only use when SearchAndMatchVersion = SearchAndMatchVersion.V2

Constructor Detail

IndexingOptionsGeneric

public IndexingOptionsGeneric(String documentId,
                              String indexId,
                              List<String> userDefinedTags)

Create options to index a document with Match V1

Parameters:

documentId - The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

indexId - The id for the index where the document should be added (case-insensitive).

userDefinedTags - (optional) The user-defined tags the document should have

IndexingOptionsGeneric

public IndexingOptionsGeneric(MatchV2Environment env,
                              String documentId,
                              List<String> roles,
                              Map<String,String> customFields)

Create options to upload a document with Match V2

Parameters:

env - The target environment where the document will be uploaded

documentId - The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores.

roles - (optional) The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used.

customFields - (optional) A key-value collection of custom fields.