ConfigurationManager (java-sdk 3.5.3)

All Known Implementing Classes:

Discovery
```
public interface ConfigurationManager
```
Interface defining the constants and methods associated with Configurations.

See Also:

Configuration

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BOLD`
`static String`	`CONFIGURATION`
`static String`	`CONFIGURATIONS`
`static String`	`CONVERSIONS`
`static String`	`CREATED`
`static String`	`DESCRIPTION`
`static String`	`DESTINATION_FIELD`
`static String`	`ENRICHMENT`
`static String`	`ENRICHMENTS`
`static String`	`EXCLUDE_CONTENT`
`static String`	`EXCLUDE_TAG_ATTRIBUTES`
`static String`	`EXCLUDE_TAGS_COMPLETELY`
`static String`	`EXCLUDE_TAGS_KEEP_CONTENT`
`static String`	`FIELD`
`static String`	`FONT_NAME`
`static String`	`FONT_SETTINGS`
`static String`	`FONT_STYLES`
`static String`	`HEADING`
`static String`	`HTML`
`static String`	`ID`
`static String`	`ITALIC`
`static String`	`JSON`
`static String`	`KEEP_CONTENT`
`static String`	`KEEP_TAG_ATTRIBUTES`
`static String`	`LEVEL`
`static String`	`MAX_SIZE`
`static String`	`MIN_SIZE`
`static String`	`NAME`
`static String`	`NAMES`
`static String`	`NORMALIZATIONS`
`static String`	`OPERATION`
`static String`	`OPTIONS`
`static String`	`OVERWRITE`
`static String`	`PDF`
`static String`	`SOURCE_FIELD`
`static String`	`STATUS`
`static String`	`TYPE`
`static String`	`UPDATED`
`static String`	`WORD`
`static String`	`XPATHS`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ServiceCall<CreateConfigurationResponse>`	`createConfiguration(CreateConfigurationRequest createRequest)` Creates a configuration.
`ServiceCall<DeleteConfigurationResponse>`	`deleteConfiguration(DeleteConfigurationRequest deleteRequest)` Deletes an existing configuration.
`ServiceCall<GetConfigurationResponse>`	`getConfiguration(GetConfigurationRequest getRequest)` Gets configuration details.
`ServiceCall<GetConfigurationsResponse>`	`getConfigurations(GetConfigurationsRequest getRequest)` Lists existing configurations.
`ServiceCall<UpdateConfigurationResponse>`	`updateConfiguration(UpdateConfigurationRequest updateRequest)` Replaces an existing configuration.

- Field Detail
  - CONFIGURATIONS
```
static final String CONFIGURATIONS
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION
```
static final String CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - ID
```
static final String ID
```
    See Also:
    
    Constant Field Values
  - NAME
```
static final String NAME
```
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
static final String DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - CREATED
```
static final String CREATED
```
    See Also:
    
    Constant Field Values
  - UPDATED
```
static final String UPDATED
```
    See Also:
    
    Constant Field Values
  - CONVERSIONS
```
static final String CONVERSIONS
```
    See Also:
    
    Constant Field Values
  - ENRICHMENTS
```
static final String ENRICHMENTS
```
    See Also:
    
    Constant Field Values
  - NORMALIZATIONS
```
static final String NORMALIZATIONS
```
    See Also:
    
    Constant Field Values
  - PDF
```
static final String PDF
```
    See Also:
    
    Constant Field Values
  - WORD
```
static final String WORD
```
    See Also:
    
    Constant Field Values
  - HTML
```
static final String HTML
```
    See Also:
    
    Constant Field Values
  - JSON
```
static final String JSON
```
    See Also:
    
    Constant Field Values
  - HEADING
```
static final String HEADING
```
    See Also:
    
    Constant Field Values
  - FONT_SETTINGS
```
static final String FONT_SETTINGS
```
    See Also:
    
    Constant Field Values
  - FONT_STYLES
```
static final String FONT_STYLES
```
    See Also:
    
    Constant Field Values
  - LEVEL
```
static final String LEVEL
```
    See Also:
    
    Constant Field Values
  - MIN_SIZE
```
static final String MIN_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_SIZE
```
static final String MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - BOLD
```
static final String BOLD
```
    See Also:
    
    Constant Field Values
  - ITALIC
```
static final String ITALIC
```
    See Also:
    
    Constant Field Values
  - FONT_NAME
```
static final String FONT_NAME
```
    See Also:
    
    Constant Field Values
  - NAMES
```
static final String NAMES
```
    See Also:
    
    Constant Field Values
  - EXCLUDE_TAGS_COMPLETELY
```
static final String EXCLUDE_TAGS_COMPLETELY
```
    See Also:
    
    Constant Field Values
  - EXCLUDE_TAGS_KEEP_CONTENT
```
static final String EXCLUDE_TAGS_KEEP_CONTENT
```
    See Also:
    
    Constant Field Values
  - KEEP_CONTENT
```
static final String KEEP_CONTENT
```
    See Also:
    
    Constant Field Values
  - EXCLUDE_CONTENT
```
static final String EXCLUDE_CONTENT
```
    See Also:
    
    Constant Field Values
  - KEEP_TAG_ATTRIBUTES
```
static final String KEEP_TAG_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - EXCLUDE_TAG_ATTRIBUTES
```
static final String EXCLUDE_TAG_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - XPATHS
```
static final String XPATHS
```
    See Also:
    
    Constant Field Values
  - OPERATION
```
static final String OPERATION
```
    See Also:
    
    Constant Field Values
  - SOURCE_FIELD
```
static final String SOURCE_FIELD
```
    See Also:
    
    Constant Field Values
  - DESTINATION_FIELD
```
static final String DESTINATION_FIELD
```
    See Also:
    
    Constant Field Values
  - OVERWRITE
```
static final String OVERWRITE
```
    See Also:
    
    Constant Field Values
  - ENRICHMENT
```
static final String ENRICHMENT
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
static final String OPTIONS
```
    See Also:
    
    Constant Field Values
  - FIELD
```
static final String FIELD
```
    See Also:
    
    Constant Field Values
  - TYPE
```
static final String TYPE
```
    See Also:
    
    Constant Field Values
  - STATUS
```
static final String STATUS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getConfigurations
```
ServiceCall<GetConfigurationsResponse> getConfigurations(GetConfigurationsRequest getRequest)
```
    Lists existing configurations. Optional query param of name can be used to search for configurations by name.
    
    Parameters:
    
    getRequest - options for getting the configurations
    
    Returns:
    
    a GetConfigurationsResponse containing result of the GetConfigurationsRequest
  - getConfiguration
```
ServiceCall<GetConfigurationResponse> getConfiguration(GetConfigurationRequest getRequest)
```
    Gets configuration details.
    
    Parameters:
    
    getRequest - options for getting the configuration
    
    Returns:
    
    a GetConfigurationResponse containing result of the GetConfigurationRequest
  - createConfiguration
```
ServiceCall<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest createRequest)
```
    Creates a configuration.
    
    Parameters:
    
    createRequest - options for creating the configuration
    
    Returns:
    
    a CreateConfigurationResponse containing the result of the CreateConfigurationRequest
  - deleteConfiguration
```
ServiceCall<DeleteConfigurationResponse> deleteConfiguration(DeleteConfigurationRequest deleteRequest)
```
    Deletes an existing configuration. The delete is performed unconditionally. A configuration delete request will succeed even if the configuration is referenced by a collection or document ingestion. However, documents which have already been submitted for processing will continue to use the deleted configuration (documents are always processed with a snapshot of the configuration as it existed at the time the document was submitted).
    
    Parameters:
    
    deleteRequest - options for deleting the configuration
    
    Returns:
    
    a DeleteConfigurationResponse containing the result of the DeleteConfigurationRequest
  - updateConfiguration
```
ServiceCall<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest updateRequest)
```
    Replaces an existing configuration. - Completely replaces the original configuration that was here before. - The 'configuration_id', 'updated', and 'created' fields accepted in the request, but they are ignored (an error is not generated). It is also acceptable for users to submit an updated config with none of the three properties. - Documents are processed with a snapshot of the configuration as it was at the time the document was submitted to be ingested. This means that already submitted documents will not see any updates made to the configuration.
    
    Parameters:
    
    updateRequest - options for updating the configuration
    
    Returns:
    
    a UpdateConfigurationResponse containing the result of the UpdateConfigurationRequest

Interface ConfigurationManager

Field Summary

Method Summary

Field Detail

CONFIGURATIONS

CONFIGURATION

ID

NAME

DESCRIPTION

CREATED

UPDATED

CONVERSIONS

ENRICHMENTS

NORMALIZATIONS

PDF

WORD

HTML

JSON

HEADING

FONT_SETTINGS

FONT_STYLES

LEVEL

MIN_SIZE

MAX_SIZE

BOLD

ITALIC

FONT_NAME

NAMES

EXCLUDE_TAGS_COMPLETELY

EXCLUDE_TAGS_KEEP_CONTENT

KEEP_CONTENT

EXCLUDE_CONTENT

KEEP_TAG_ATTRIBUTES

EXCLUDE_TAG_ATTRIBUTES

XPATHS

OPERATION

SOURCE_FIELD

DESTINATION_FIELD

OVERWRITE

ENRICHMENT

OPTIONS

FIELD

TYPE

STATUS

Method Detail

getConfigurations

getConfiguration

createConfiguration

deleteConfiguration

updateConfiguration