ElasticsearchFunctions (herd docs javadoc 0.38.0 API)

java.lang.Object
- org.finra.herd.service.functional.ElasticsearchFunctions

All Implemented Interfaces:

SearchFunctions
```
@Component
public class ElasticsearchFunctions
extends Object
implements SearchFunctions
```
This class contains functions that can be used to work with an Elasticsearch index.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BDEF_NAME_AGGS` The business object definition name sub agg
`static String`	`BDEF_NAME_FIELD` business object definition name field
`static String`	`BUSINESS_OBJECT_DEFINITION_SORT_FIELD` Sort the business object definition by name
`static String`	`DATA_PROVIDER_NAME_SOURCE` Source string for the dataProvider name
`static String`	`DESCRIPTION_SOURCE` Source string for the description
`static String`	`DISPLAY_NAME_SOURCE` Source string for the display name
`static int`	`ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME` Scroll keep alive in milliseconds
`static int`	`ELASTIC_SEARCH_SCROLL_PAGE_SIZE` Page size
`static String`	`NAME_SOURCE` Source string for the name
`static String`	`NAMESPACE_CODE_AGGS` The namespace code sub agg
`static String`	`NAMESPACE_CODE_SORT_FIELD` Raw field for the namespace code
`static String`	`NAMESPACE_CODE_SOURCE` Source string for the namespace code
`static String`	`NAMESPACE_FIELD` namespace field
`static String`	`NESTED_BDEFTAGS_PATH` The nested path of business object definition tags
`static String`	`SEARCH_INDEX_BUSINESS_OBJECT_DEFINITION_ID_KEY` The business object definition id search index key
`static String`	`TAG_CODE_AGGREGATION` The user defined tag code sub aggregation name.
`static String`	`TAG_CODE_FIELD` The tag code field
`static String`	`TAG_FACET` The tag Facet Field name
`static String`	`TAG_FACET_AGGS` The nested aggregation name for tag facet.
`static String`	`TAG_NAME_AGGREGATION` The user defined tag display name sub aggregation name.
`static String`	`TAG_NAME_FIELD` The tag display name field
`static String`	`TAG_TYPE_FACET_AGGS` The user defined agg name for tag type facet.
`static String`	`TAGTYPE_CODE_AGGREGATION` The user defined tag type code sub aggregation name.
`static String`	`TAGTYPE_CODE_FIELD` The tag type code field
`static String`	`TAGTYPE_NAME_AGGREGATION` The user defined tag type display name sub aggregation name.
`static String`	`TAGTYPE_NAME_FIELD` The tag type display name field

Constructor Summary

Constructors
Constructor and Description

ElasticsearchFunctions()

Constructors
Constructor and Description
`ElasticsearchFunctions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TriConsumer<String,String,Map<String,String>>`	`getCreateIndexDocumentsFunction()` The create index documents function will take as arguments the index name, document type, and a map of new documents.
`TriConsumer<String,String,String>`	`getCreateIndexFunction()` The create index function will take as arguments the index name, document type, and mapping and will create a new index.
`TriConsumer<String,String,String>`	`getDeleteDocumentByIdFunction()` The delete document by id function will delete a document in the index by the document id.
`TriConsumer<String,String,List<Integer>>`	`getDeleteIndexDocumentsFunction()` The delete index documents function will delete a list of document in the index by a list of document ids.
`Consumer<String>`	`getDeleteIndexFunction()` The delete index function will take as an argument the index name and will delete the index.
`TriFunction<String,String,Set<String>,ElasticsearchResponseDto>`	`getFindAllBusinessObjectDefinitionsFunction()` The find all business object definitions function will return all business object definition entities in the search index.
`BiFunction<String,String,List<String>>`	`getIdsInIndexFunction()` The ids in index function will take as arguments the index name and the document type and will return a list of all the ids in the index.
`Predicate<String>`	`getIndexExistsFunction()` The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.
`QuadConsumer<String,String,String,String>`	`getIndexFunction()` The index function will take as arguments indexName, documentType, id, json and add the document to the index.
`QuadPredicate<String,String,String,String>`	`getIsValidFunction()` The isValid function will take as arguments indexName, documentType, id, json and validate the document against the index and return true if the document is valid and false otherwise.
`BiFunction<String,String,Long>`	`getNumberOfTypesInIndexFunction()` The number of types in index function will take as arguments the index name and the document type and will return the number of documents in the index.
`QuadFunction<String,String,List<List<TagEntity>>,Set<String>,ElasticsearchResponseDto>`	`getSearchBusinessObjectDefinitionsByTagsFunction()` The search business object definitions by tags function will take a list of tag entities list and return a list of business object definition entities.
`TriConsumer<String,String,Map<String,String>>`	`getUpdateIndexDocumentsFunction()` The update index documents function will take as arguments the index name, document type, and a map of documents to update.
`QuadConsumer<String,String,String,String>`	`getValidateFunction()` The validate function will take as arguments indexName, documentType, id, json and validate the document against the index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ELASTIC_SEARCH_SCROLL_PAGE_SIZE
```
public static final int ELASTIC_SEARCH_SCROLL_PAGE_SIZE
```
    Page size
    
    See Also:
    
    Constant Field Values
  - ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME
```
public static final int ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME
```
    Scroll keep alive in milliseconds
    
    See Also:
    
    Constant Field Values
  - BUSINESS_OBJECT_DEFINITION_SORT_FIELD
```
public static final String BUSINESS_OBJECT_DEFINITION_SORT_FIELD
```
    Sort the business object definition by name
    
    See Also:
    
    Constant Field Values
  - SEARCH_INDEX_BUSINESS_OBJECT_DEFINITION_ID_KEY
```
public static final String SEARCH_INDEX_BUSINESS_OBJECT_DEFINITION_ID_KEY
```
    The business object definition id search index key
    
    See Also:
    
    Constant Field Values
  - DATA_PROVIDER_NAME_SOURCE
```
public static final String DATA_PROVIDER_NAME_SOURCE
```
    Source string for the dataProvider name
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_SOURCE
```
public static final String DESCRIPTION_SOURCE
```
    Source string for the description
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_SOURCE
```
public static final String DISPLAY_NAME_SOURCE
```
    Source string for the display name
    
    See Also:
    
    Constant Field Values
  - NAME_SOURCE
```
public static final String NAME_SOURCE
```
    Source string for the name
    
    See Also:
    
    Constant Field Values
  - NAMESPACE_CODE_SOURCE
```
public static final String NAMESPACE_CODE_SOURCE
```
    Source string for the namespace code
    
    See Also:
    
    Constant Field Values
  - NAMESPACE_CODE_SORT_FIELD
```
public static final String NAMESPACE_CODE_SORT_FIELD
```
    Raw field for the namespace code
    
    See Also:
    
    Constant Field Values
  - NESTED_BDEFTAGS_PATH
```
public static final String NESTED_BDEFTAGS_PATH
```
    The nested path of business object definition tags
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_CODE_FIELD
```
public static final String TAGTYPE_CODE_FIELD
```
    The tag type code field
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_NAME_FIELD
```
public static final String TAGTYPE_NAME_FIELD
```
    The tag type display name field
    
    See Also:
    
    Constant Field Values
  - TAG_CODE_FIELD
```
public static final String TAG_CODE_FIELD
```
    The tag code field
    
    See Also:
    
    Constant Field Values
  - TAG_NAME_FIELD
```
public static final String TAG_NAME_FIELD
```
    The tag display name field
    
    See Also:
    
    Constant Field Values
  - TAG_FACET_AGGS
```
public static final String TAG_FACET_AGGS
```
    The nested aggregation name for tag facet. User defined.
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_CODE_AGGREGATION
```
public static final String TAGTYPE_CODE_AGGREGATION
```
    The user defined tag type code sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAGTYPE_NAME_AGGREGATION
```
public static final String TAGTYPE_NAME_AGGREGATION
```
    The user defined tag type display name sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_CODE_AGGREGATION
```
public static final String TAG_CODE_AGGREGATION
```
    The user defined tag code sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_NAME_AGGREGATION
```
public static final String TAG_NAME_AGGREGATION
```
    The user defined tag display name sub aggregation name.
    
    See Also:
    
    Constant Field Values
  - TAG_FACET
```
public static final String TAG_FACET
```
    The tag Facet Field name
    
    See Also:
    
    Constant Field Values
  - TAG_TYPE_FACET_AGGS
```
public static final String TAG_TYPE_FACET_AGGS
```
    The user defined agg name for tag type facet.
    
    See Also:
    
    Constant Field Values
  - NAMESPACE_CODE_AGGS
```
public static final String NAMESPACE_CODE_AGGS
```
    The namespace code sub agg
    
    See Also:
    
    Constant Field Values
  - BDEF_NAME_AGGS
```
public static final String BDEF_NAME_AGGS
```
    The business object definition name sub agg
    
    See Also:
    
    Constant Field Values
  - NAMESPACE_FIELD
```
public static final String NAMESPACE_FIELD
```
    namespace field
    
    See Also:
    
    Constant Field Values
  - BDEF_NAME_FIELD
```
public static final String BDEF_NAME_FIELD
```
    business object definition name field
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ElasticsearchFunctions
```
public ElasticsearchFunctions()
```
- Method Detail
  - getIndexFunction
```
public QuadConsumer<String,String,String,String> getIndexFunction()
```
    Description copied from interface: SearchFunctions
    
    The index function will take as arguments indexName, documentType, id, json and add the document to the index.
    
    Specified by:
    
    getIndexFunction in interface SearchFunctions
  - getValidateFunction
```
public QuadConsumer<String,String,String,String> getValidateFunction()
```
    Description copied from interface: SearchFunctions
    
    The validate function will take as arguments indexName, documentType, id, json and validate the document against the index.
    
    Specified by:
    
    getValidateFunction in interface SearchFunctions
  - getIsValidFunction
```
public QuadPredicate<String,String,String,String> getIsValidFunction()
```
    Description copied from interface: SearchFunctions
    
    The isValid function will take as arguments indexName, documentType, id, json and validate the document against the index and return true if the document is valid and false otherwise.
    
    Specified by:
    
    getIsValidFunction in interface SearchFunctions
  - getIndexExistsFunction
```
public Predicate<String> getIndexExistsFunction()
```
    Description copied from interface: SearchFunctions
    
    The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.
    
    Specified by:
    
    getIndexExistsFunction in interface SearchFunctions
  - getDeleteIndexFunction
```
public Consumer<String> getDeleteIndexFunction()
```
    Description copied from interface: SearchFunctions
    
    The delete index function will take as an argument the index name and will delete the index.
    
    Specified by:
    
    getDeleteIndexFunction in interface SearchFunctions
  - getCreateIndexDocumentsFunction
```
public TriConsumer<String,String,Map<String,String>> getCreateIndexDocumentsFunction()
```
    Description copied from interface: SearchFunctions
    
    The create index documents function will take as arguments the index name, document type, and a map of new documents. The document map key is the document id, and the value is the document as a JSON string.
    
    Specified by:
    
    getCreateIndexDocumentsFunction in interface SearchFunctions
  - getCreateIndexFunction
```
public TriConsumer<String,String,String> getCreateIndexFunction()
```
    Description copied from interface: SearchFunctions
    
    The create index function will take as arguments the index name, document type, and mapping and will create a new index.
    
    Specified by:
    
    getCreateIndexFunction in interface SearchFunctions
  - getDeleteDocumentByIdFunction
```
public TriConsumer<String,String,String> getDeleteDocumentByIdFunction()
```
    Description copied from interface: SearchFunctions
    
    The delete document by id function will delete a document in the index by the document id.
    
    Specified by:
    
    getDeleteDocumentByIdFunction in interface SearchFunctions
  - getDeleteIndexDocumentsFunction
```
public TriConsumer<String,String,List<Integer>> getDeleteIndexDocumentsFunction()
```
    Description copied from interface: SearchFunctions
    
    The delete index documents function will delete a list of document in the index by a list of document ids.
    
    Specified by:
    
    getDeleteIndexDocumentsFunction in interface SearchFunctions
  - getNumberOfTypesInIndexFunction
```
public BiFunction<String,String,Long> getNumberOfTypesInIndexFunction()
```
    Description copied from interface: SearchFunctions
    
    The number of types in index function will take as arguments the index name and the document type and will return the number of documents in the index.
    
    Specified by:
    
    getNumberOfTypesInIndexFunction in interface SearchFunctions
  - getIdsInIndexFunction
```
public BiFunction<String,String,List<String>> getIdsInIndexFunction()
```
    Description copied from interface: SearchFunctions
    
    The ids in index function will take as arguments the index name and the document type and will return a list of all the ids in the index.
    
    Specified by:
    
    getIdsInIndexFunction in interface SearchFunctions
  - getFindAllBusinessObjectDefinitionsFunction
```
public TriFunction<String,String,Set<String>,ElasticsearchResponseDto> getFindAllBusinessObjectDefinitionsFunction()
```
    Description copied from interface: SearchFunctions
    
    The find all business object definitions function will return all business object definition entities in the search index.
    
    Specified by:
    
    getFindAllBusinessObjectDefinitionsFunction in interface SearchFunctions
  - getSearchBusinessObjectDefinitionsByTagsFunction
```
public QuadFunction<String,String,List<List<TagEntity>>,Set<String>,ElasticsearchResponseDto> getSearchBusinessObjectDefinitionsByTagsFunction()
```
    Description copied from interface: SearchFunctions
    
    The search business object definitions by tags function will take a list of tag entities list and return a list of business object definition entities. The function will search the search index based on tag code and tag type code.
    
    Specified by:
    
    getSearchBusinessObjectDefinitionsByTagsFunction in interface SearchFunctions
  - getUpdateIndexDocumentsFunction
```
public TriConsumer<String,String,Map<String,String>> getUpdateIndexDocumentsFunction()
```
    Description copied from interface: SearchFunctions
    
    The update index documents function will take as arguments the index name, document type, and a map of documents to update. The document map key is the document id, and the value is the document as a JSON string.
    
    Specified by:
    
    getUpdateIndexDocumentsFunction in interface SearchFunctions

Class ElasticsearchFunctions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ELASTIC_SEARCH_SCROLL_PAGE_SIZE

ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME

BUSINESS_OBJECT_DEFINITION_SORT_FIELD

SEARCH_INDEX_BUSINESS_OBJECT_DEFINITION_ID_KEY

DATA_PROVIDER_NAME_SOURCE

DESCRIPTION_SOURCE

DISPLAY_NAME_SOURCE

NAME_SOURCE

NAMESPACE_CODE_SOURCE

NAMESPACE_CODE_SORT_FIELD

NESTED_BDEFTAGS_PATH

TAGTYPE_CODE_FIELD

TAGTYPE_NAME_FIELD

TAG_CODE_FIELD

TAG_NAME_FIELD

TAG_FACET_AGGS

TAGTYPE_CODE_AGGREGATION

TAGTYPE_NAME_AGGREGATION

TAG_CODE_AGGREGATION

TAG_NAME_AGGREGATION

TAG_FACET

TAG_TYPE_FACET_AGGS

NAMESPACE_CODE_AGGS

BDEF_NAME_AGGS

NAMESPACE_FIELD

BDEF_NAME_FIELD

Constructor Detail

ElasticsearchFunctions

Method Detail

getIndexFunction

getValidateFunction

getIsValidFunction

getIndexExistsFunction

getDeleteIndexFunction

getCreateIndexDocumentsFunction

getCreateIndexFunction

getDeleteDocumentByIdFunction

getDeleteIndexDocumentsFunction

getNumberOfTypesInIndexFunction

getIdsInIndexFunction

getFindAllBusinessObjectDefinitionsFunction

getSearchBusinessObjectDefinitionsByTagsFunction

getUpdateIndexDocumentsFunction