com.ibm.watson.developer_cloud.document_conversion.v1.model

Class IndexDocumentOptions

java.lang.Object

com.ibm.watson.developer_cloud.document_conversion.v1.model.IndexDocumentOptions

public class IndexDocumentOptions
extends Object

Options when indexing a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDocumentOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	convertDocumentConfig() Gets the configuration for the convert document phase.
File	document() Gets the document.
Boolean	dryRun() Gets the dryRun flag.
InputStream	getDocumentInputStream() Gets the document as an input stream.
IndexConfiguration	indexConfiguration() Gets configuration for the retrieve and rank service for the indexing phase.
String	mediaType() Gets the media type.
Map<String,String>	metadata() Gets the metadata.
IndexDocumentOptions.Builder	newBuilder() New builder.

Methods inherited from class java.lang.Object

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

Method Detail

convertDocumentConfig

public com.google.gson.JsonObject convertDocumentConfig()

Gets the configuration for the convert document phase.

Returns:

conversionConfiguration Configuration for the convert document phase

document

public File document()

Gets the document.

Returns:

document The document to be converted and indexed

dryRun

public Boolean dryRun()

Gets the dryRun flag.

Returns:

dryRun If true, performs a dry run for testing purposes (document won't be indexed), else to index the document

getDocumentInputStream

public InputStream getDocumentInputStream()

Gets the document as an input stream.

Returns:

InputStream The document to be converted and indexed

indexConfiguration

public IndexConfiguration indexConfiguration()

Gets configuration for the retrieve and rank service for the indexing phase.

Returns:

indexConfiguration Configuration for the retrieve and rank service for the indexing phase

mediaType

public String mediaType()

Gets the media type.

Returns:

mediaType The media type of the document to be converted and indexed

metadata

public Map<String,String> metadata()

Gets the metadata.

Returns:

metadata The metadata of the document that will be indexed

newBuilder

public IndexDocumentOptions.Builder newBuilder()

New builder.

Returns:

the builder