com.ibm.watson.developer_cloud.discovery.v1

Class Discovery

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.discovery.v1.Discovery

All Implemented Interfaces:

CollectionManager, ConfigurationManager, DocumentManager, EnvironmentManager, QueryManager

public class Discovery
extends WatsonService
implements EnvironmentManager, ConfigurationManager, CollectionManager, DocumentManager, QueryManager

Discovery service API for CRUD operations for indexing and searching data.

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Fields inherited from interface com.ibm.watson.developer_cloud.discovery.v1.model.environment.EnvironmentManager

CREATED, DESCRIPTION, DISK_USAGE, ENVIRONMENTS, ID, INDEX_CAPACITY, MEMORY_USAGE, NAME, PERCENT_USED, READ_ONLY, SIZE, STATUS, TOTAL, TOTAL_BYTES, UPDATED, USED, USED_BYTES

Fields inherited from interface com.ibm.watson.developer_cloud.discovery.v1.model.configuration.ConfigurationManager

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

Fields inherited from interface com.ibm.watson.developer_cloud.discovery.v1.model.collection.CollectionManager

AVAILABLE, COLLECTIONS, CONFIGURATION_ID, CREATED, DESCRIPTION, DOCUMENT_COUNTS, FAILED, FIELD, FIELDS, ID, LANGUAGE, NAME, PROCESSING, STATUS, TYPE, UPDATED

Fields inherited from interface com.ibm.watson.developer_cloud.discovery.v1.model.document.DocumentManager

CONFIGURATION_ID, CREATED, FILE, ID, METADATA, STATUS, STATUS_DESCRIPTION, UPDATED

Fields inherited from interface com.ibm.watson.developer_cloud.discovery.v1.model.query.QueryManager

AGGREGATION, AGGREGATION_ID, AGGREGATIONS, COUNT, COUNT_PARAM, FIELD, FILTER, ID, INTERNAL_ID, INTERVAL, KEY, LOGIC, MATCHING_RESULTS, OFFSET, QUERY, RESULTS, RETURN, SCORE, TYPE, VALUE

Constructor Summary

Constructors

Constructor and Description
Discovery(java.lang.String versionDate) Instantiates a new Discovery service.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	cleanFieldName(java.lang.String fieldName) Utility method to replace unsupported characters in a field name.
ServiceCall<CreateCollectionResponse>	createCollection(CreateCollectionRequest createRequest) Creates a Collection.
ServiceCall<CreateConfigurationResponse>	createConfiguration(CreateConfigurationRequest createRequest) Creates a configuration.
ServiceCall<CreateDocumentResponse>	createDocument(CreateDocumentRequest createRequest) Starts ingesting a document with optional metadata and optional configuration overrides.
ServiceCall<CreateEnvironmentResponse>	createEnvironment(CreateEnvironmentRequest createRequest) Creates a new environment.
ServiceCall<DeleteCollectionResponse>	deleteCollection(DeleteCollectionRequest deleteRequest) Deletes a Collection.
ServiceCall<DeleteConfigurationResponse>	deleteConfiguration(DeleteConfigurationRequest deleteRequest) Deletes an existing configuration.
ServiceCall<DeleteDocumentResponse>	deleteDocument(DeleteDocumentRequest deleteRequest) Deletes a Document.
ServiceCall<DeleteEnvironmentResponse>	deleteEnvironment(DeleteEnvironmentRequest deleteRequest) Deletes an existing environment.
static java.lang.String	escapeControlChracters(java.lang.String value) Utility method to escape control characters in a value for querying.
ServiceCall<GetCollectionResponse>	getCollection(GetCollectionRequest getRequest) Gets a Collection.
ServiceCall<GetCollectionFieldsResponse>	getCollectionFields(GetCollectionFieldsRequest getRequest) Gets a list of unique Fields from a Collection.
ServiceCall<GetCollectionsResponse>	getCollections(GetCollectionsRequest getRequest) Gets a list of Collection.
ServiceCall<GetConfigurationResponse>	getConfiguration(GetConfigurationRequest getRequest) Gets configuration details.
ServiceCall<GetConfigurationsResponse>	getConfigurations(GetConfigurationsRequest getRequest) Lists existing configurations.
ServiceCall<GetDocumentResponse>	getDocument(GetDocumentRequest getRequest) Gets a Document.
ServiceCall<GetEnvironmentResponse>	getEnvironment(GetEnvironmentRequest getRequest) Gets details about an existing environment.
ServiceCall<GetEnvironmentsResponse>	getEnvironments(GetEnvironmentsRequest getRequest) Lists existing environments.
boolean	ping() Ping the service.
ServiceCall<QueryResponse>	query(QueryRequest queryRequest) Executes a query.
ServiceCall<UpdateConfigurationResponse>	updateConfiguration(UpdateConfigurationRequest updateRequest) Replaces an existing configuration.
ServiceCall<UpdateDocumentResponse>	updateDocument(UpdateDocumentRequest updateRequest) Starts ingesting a source document to create or replace an existing document.
ServiceCall<UpdateEnvironmentResponse>	updateEnvironment(UpdateEnvironmentRequest updateRequest) Updates an environment.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Discovery

public Discovery(java.lang.String versionDate)

Instantiates a new Discovery service.

Parameters:

versionDate - the version date

Method Detail

cleanFieldName

public static java.lang.String cleanFieldName(java.lang.String fieldName)

Utility method to replace unsupported characters in a field name.

Parameters:

fieldName - the field name to escape

Returns:

a clean field name

escapeControlChracters

public static java.lang.String escapeControlChracters(java.lang.String value)

Utility method to escape control characters in a value for querying.

Parameters:

value - the value that potentially contains control characters

Returns:

a value with control characters escaped

ping

public boolean ping()
             throws java.lang.RuntimeException

Ping the service.

Returns:

true if the service is reachable

Throws:

java.lang.RuntimeException - if the service is unreachable

getEnvironments

public ServiceCall<GetEnvironmentsResponse> getEnvironments(GetEnvironmentsRequest getRequest)

Description copied from interface: EnvironmentManager

Lists existing environments. Optional query param of name can be used to search for environments by name.

Specified by:

getEnvironments in interface EnvironmentManager

Parameters:

getRequest - options for getting the environments

Returns:

a GetEnvironmentsResponse containing result of the GetEnvironmentsRequest

getEnvironment

public ServiceCall<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getRequest)

Description copied from interface: EnvironmentManager

Gets details about an existing environment.

Specified by:

getEnvironment in interface EnvironmentManager

Parameters:

getRequest - options for getting the environment

Returns:

a GetEnvironmentResponse containing the result of the GetEnvironmentRequest

createEnvironment

public ServiceCall<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createRequest)

Description copied from interface: EnvironmentManager

Creates a new environment.

Specified by:

createEnvironment in interface EnvironmentManager

Parameters:

createRequest - options for creating the environment

Returns:

a CreateEnvironmentResponse containing the result of the CreateEnvironmentRequest

deleteEnvironment

public ServiceCall<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteRequest)

Description copied from interface: EnvironmentManager

Deletes an existing environment.

Specified by:

deleteEnvironment in interface EnvironmentManager

Parameters:

deleteRequest - options for deleting the environment

Returns:

a DeleteEnvironmentResponse containing the result of the DeleteEnvironmentRequest

updateEnvironment

public ServiceCall<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateRequest)

Description copied from interface: EnvironmentManager

Updates an environment.

Specified by:

updateEnvironment in interface EnvironmentManager

Parameters:

updateRequest - options for deleting the environment

Returns:

a UpdateEnvironmentResponse containing the result of the UpdateEnvironmentRequest

getConfigurations

public ServiceCall<GetConfigurationsResponse> getConfigurations(GetConfigurationsRequest getRequest)

Description copied from interface: ConfigurationManager

Lists existing configurations. Optional query param of name can be used to search for configurations by name.

Specified by:

getConfigurations in interface ConfigurationManager

Parameters:

getRequest - options for getting the configurations

Returns:

a GetConfigurationsResponse containing result of the GetConfigurationsRequest

getConfiguration

public ServiceCall<GetConfigurationResponse> getConfiguration(GetConfigurationRequest getRequest)

Description copied from interface: ConfigurationManager

Gets configuration details.

Specified by:

getConfiguration in interface ConfigurationManager

Parameters:

getRequest - options for getting the configuration

Returns:

a GetConfigurationResponse containing result of the GetConfigurationRequest

createConfiguration

public ServiceCall<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest createRequest)

Description copied from interface: ConfigurationManager

Creates a configuration.

Specified by:

createConfiguration in interface ConfigurationManager

Parameters:

createRequest - options for creating the configuration

Returns:

a CreateConfigurationResponse containing the result of the CreateConfigurationRequest

deleteConfiguration

public ServiceCall<DeleteConfigurationResponse> deleteConfiguration(DeleteConfigurationRequest deleteRequest)

Description copied from interface: ConfigurationManager

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).

Specified by:

deleteConfiguration in interface ConfigurationManager

Parameters:

deleteRequest - options for deleting the configuration

Returns:

a DeleteConfigurationResponse containing the result of the DeleteConfigurationRequest

updateConfiguration

public ServiceCall<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest updateRequest)

Description copied from interface: ConfigurationManager

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.

Specified by:

updateConfiguration in interface ConfigurationManager

Parameters:

updateRequest - options for updating the configuration

Returns:

a UpdateConfigurationResponse containing the result of the UpdateConfigurationRequest

getCollections

public ServiceCall<GetCollectionsResponse> getCollections(GetCollectionsRequest getRequest)

Description copied from interface: CollectionManager

Gets a list of Collection. An optional parameter of name can be provided to filter by name.

Specified by:

getCollections in interface CollectionManager

Parameters:

getRequest - options for getting the Collections

Returns:

a GetCollectionsResponse containing the result of GetCollectionsRequest

getCollection

public ServiceCall<GetCollectionResponse> getCollection(GetCollectionRequest getRequest)

Description copied from interface: CollectionManager

Gets a Collection.

Specified by:

getCollection in interface CollectionManager

Parameters:

getRequest - options for getting the Collection

Returns:

a GetCollectionResponse containing the result of GetCollectionRequest

createCollection

public ServiceCall<CreateCollectionResponse> createCollection(CreateCollectionRequest createRequest)

Description copied from interface: CollectionManager

Creates a Collection.

Specified by:

createCollection in interface CollectionManager

Parameters:

createRequest - options for creating a Collection

Returns:

a CreateCollectionResponse containing the result of CreateCollectionRequest

deleteCollection

public ServiceCall<DeleteCollectionResponse> deleteCollection(DeleteCollectionRequest deleteRequest)

Description copied from interface: CollectionManager

Deletes a Collection.

Specified by:

deleteCollection in interface CollectionManager

Parameters:

deleteRequest - options for deleting a Collection

Returns:

a DeleteCollectionResponse containing the result of DeleteCollectionRequest

getCollectionFields

public ServiceCall<GetCollectionFieldsResponse> getCollectionFields(GetCollectionFieldsRequest getRequest)

Description copied from interface: CollectionManager

Gets a list of unique Fields from a Collection.

Specified by:

getCollectionFields in interface CollectionManager

Parameters:

getRequest - options for getting a unique fields from a Collection

Returns:

a GetCollectionFieldsResponse containing the result of GetCollectionFieldsRequest

getDocument

public ServiceCall<GetDocumentResponse> getDocument(GetDocumentRequest getRequest)

Description copied from interface: DocumentManager

Gets a Document.

Specified by:

getDocument in interface DocumentManager

Parameters:

getRequest - options for getting a Document

Returns:

a GetDocumentResponse containing the details of GetDocumentRequest

createDocument

public ServiceCall<CreateDocumentResponse> createDocument(CreateDocumentRequest createRequest)

Description copied from interface: DocumentManager

Starts ingesting a document with optional metadata and optional configuration overrides. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected. User can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (e.g. application/octet-stream), then the service will attempt to automatically detect the document's media type.

Specified by:

createDocument in interface DocumentManager

Parameters:

createRequest - options for creating a Document

Returns:

a CreateDocumentResponse containing the details of CreateDocumentRequest

deleteDocument

public ServiceCall<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteRequest)

Description copied from interface: DocumentManager

Deletes a Document.

Specified by:

deleteDocument in interface DocumentManager

Parameters:

deleteRequest - options for deleting a Document

Returns:

a DeleteDocumentResponse containing the details of DeleteDocumentRequest

updateDocument

public ServiceCall<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateRequest)

Description copied from interface: DocumentManager

Starts ingesting a source document to create or replace an existing document. This is a POST operation instead of a PUT operation because an existing document may be partially updated, depending on whether or not the new, replacement document is successfully ingested (see the next bullet for details). - If a document already exists with the provided Document ID, then the fate of the original document depends on whether or not the new document is successfully ingested - If the new document fails, then the original document is left intact in the collection's index. However, any previous notices (warnings or errors) that were stored for the original document are replaced with the new document's notices. - If the new document is successfully processed, then the original document is replaced with the new document in the collection's index, including any notices. - Only the document_id from the request path is used. If the user provides a document_id in the input document (assuming JSON is submitted), it will be ignored. Returns immediately after the system has accepted the document for processing. The user must provide document content, metadata, or both. If the request is missing both document content and metadata, then it will be rejected. User can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (e.g. application/octet-stream), then the service will attempt to automatically detect the document's media type.

Specified by:

updateDocument in interface DocumentManager

Parameters:

updateRequest - options for updating a Document

Returns:

a UpdateDocumentResponse containing the details of UpdateDocumentRequest

query

public ServiceCall<QueryResponse> query(QueryRequest queryRequest)

Description copied from interface: QueryManager

Executes a query.

Specified by:

query in interface QueryManager

Parameters:

queryRequest - options for the query

Returns:

a QueryResponse containing the details from the QueryRequest