com.ibm.watson.developer_cloud.discovery.v1.model.configuration

Interface ConfigurationManager

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 java.lang.String	BOLD
static java.lang.String	CONFIGURATION
static java.lang.String	CONFIGURATIONS
static java.lang.String	CONVERSIONS
static java.lang.String	CREATED
static java.lang.String	DESCRIPTION
static java.lang.String	DESTINATION_FIELD
static java.lang.String	ENRICHMENT
static java.lang.String	ENRICHMENTS
static java.lang.String	EXCLUDE_CONTENT
static java.lang.String	EXCLUDE_TAG_ATTRIBUTES
static java.lang.String	EXCLUDE_TAGS_COMPLETELY
static java.lang.String	EXCLUDE_TAGS_KEEP_CONTENT
static java.lang.String	FIELD
static java.lang.String	FONT_NAME
static java.lang.String	FONT_SETTINGS
static java.lang.String	FONT_STYLES
static java.lang.String	HEADING
static java.lang.String	HTML
static java.lang.String	ID
static java.lang.String	ITALIC
static java.lang.String	JSON
static java.lang.String	KEEP_CONTENT
static java.lang.String	KEEP_TAG_ATTRIBUTES
static java.lang.String	LEVEL
static java.lang.String	MAX_SIZE
static java.lang.String	MIN_SIZE
static java.lang.String	NAME
static java.lang.String	NAMES
static java.lang.String	NORMALIZATIONS
static java.lang.String	OPERATION
static java.lang.String	OPTIONS
static java.lang.String	OVERWRITE
static java.lang.String	PDF
static java.lang.String	SOURCE_FIELD
static java.lang.String	STATUS
static java.lang.String	TYPE
static java.lang.String	UPDATED
static java.lang.String	WORD
static java.lang.String	XPATHS

Method Summary

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 java.lang.String CONFIGURATIONS

See Also:

Constant Field Values

CONFIGURATION

static final java.lang.String CONFIGURATION

See Also:

Constant Field Values

ID

static final java.lang.String ID

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

CREATED

static final java.lang.String CREATED

See Also:

Constant Field Values

UPDATED

static final java.lang.String UPDATED

See Also:

Constant Field Values

CONVERSIONS

static final java.lang.String CONVERSIONS

See Also:

Constant Field Values

ENRICHMENTS

static final java.lang.String ENRICHMENTS

See Also:

Constant Field Values

NORMALIZATIONS

static final java.lang.String NORMALIZATIONS

See Also:

Constant Field Values

PDF

static final java.lang.String PDF

See Also:

Constant Field Values

WORD

static final java.lang.String WORD

See Also:

Constant Field Values

HTML

static final java.lang.String HTML

See Also:

Constant Field Values

JSON

static final java.lang.String JSON

See Also:

Constant Field Values

HEADING

static final java.lang.String HEADING

See Also:

Constant Field Values

FONT_SETTINGS

static final java.lang.String FONT_SETTINGS

See Also:

Constant Field Values

FONT_STYLES

static final java.lang.String FONT_STYLES

See Also:

Constant Field Values

LEVEL

static final java.lang.String LEVEL

See Also:

Constant Field Values

MIN_SIZE

static final java.lang.String MIN_SIZE

See Also:

Constant Field Values

MAX_SIZE

static final java.lang.String MAX_SIZE

See Also:

Constant Field Values

BOLD

static final java.lang.String BOLD

See Also:

Constant Field Values

ITALIC

static final java.lang.String ITALIC

See Also:

Constant Field Values

FONT_NAME

static final java.lang.String FONT_NAME

See Also:

Constant Field Values

NAMES

static final java.lang.String NAMES

See Also:

Constant Field Values

EXCLUDE_TAGS_COMPLETELY

static final java.lang.String EXCLUDE_TAGS_COMPLETELY

See Also:

Constant Field Values

EXCLUDE_TAGS_KEEP_CONTENT

static final java.lang.String EXCLUDE_TAGS_KEEP_CONTENT

See Also:

Constant Field Values

KEEP_CONTENT

static final java.lang.String KEEP_CONTENT

See Also:

Constant Field Values

EXCLUDE_CONTENT

static final java.lang.String EXCLUDE_CONTENT

See Also:

Constant Field Values

KEEP_TAG_ATTRIBUTES

static final java.lang.String KEEP_TAG_ATTRIBUTES

See Also:

Constant Field Values

EXCLUDE_TAG_ATTRIBUTES

static final java.lang.String EXCLUDE_TAG_ATTRIBUTES

See Also:

Constant Field Values

XPATHS

static final java.lang.String XPATHS

See Also:

Constant Field Values

OPERATION

static final java.lang.String OPERATION

See Also:

Constant Field Values

SOURCE_FIELD

static final java.lang.String SOURCE_FIELD

See Also:

Constant Field Values

DESTINATION_FIELD

static final java.lang.String DESTINATION_FIELD

See Also:

Constant Field Values

OVERWRITE

static final java.lang.String OVERWRITE

See Also:

Constant Field Values

ENRICHMENT

static final java.lang.String ENRICHMENT

See Also:

Constant Field Values

OPTIONS

static final java.lang.String OPTIONS

See Also:

Constant Field Values

FIELD

static final java.lang.String FIELD

See Also:

Constant Field Values

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

STATUS

static final java.lang.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