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

Class IndexDocumentOptions.Builder

java.lang.Object

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

Enclosing class:

IndexDocumentOptions

public static class IndexDocumentOptions.Builder
extends java.lang.Object

Builder.

Constructor Summary

Constructors

Constructor and Description
IndexDocumentOptions.Builder() Instantiates a new builder.

Method Summary

Methods

Modifier and Type	Method and Description
IndexDocumentOptions	build() Builds the index document options.
IndexDocumentOptions.Builder	convertDocumentConfig(com.google.gson.JsonObject convertDocumentConfig) Sets the convert document configuration.
IndexDocumentOptions.Builder	document(java.io.File document) Sets the document.
IndexDocumentOptions.Builder	document(java.io.InputStream document, java.lang.String mediaType) Sets the document as an input stream and its media type.
IndexDocumentOptions.Builder	dryRun(java.lang.Boolean dryRun) Sets the dryRun flag.
IndexDocumentOptions.Builder	indexConfiguration(IndexConfiguration indexConfiguration) Sets the retrieve and rank configuration.
IndexDocumentOptions.Builder	mediaType(java.lang.String mediaType) Sets the media type.
IndexDocumentOptions.Builder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDocumentOptions.Builder

public IndexDocumentOptions.Builder()

Instantiates a new builder.

Method Detail

build

public IndexDocumentOptions build()

Builds the index document options.

Returns:

the index document options

convertDocumentConfig

public IndexDocumentOptions.Builder convertDocumentConfig(com.google.gson.JsonObject convertDocumentConfig)

Sets the convert document configuration.

Parameters:

convertDocumentConfig - Configuration for the convert document phase

Returns:

the index document options

document

public IndexDocumentOptions.Builder document(java.io.File document)

Sets the document.

Parameters:

document - The document to be converted and indexed

Returns:

the index document options

document

public IndexDocumentOptions.Builder document(java.io.InputStream document,
                                    java.lang.String mediaType)

Sets the document as an input stream and its media type.

Parameters:

document - The document to be converted and indexed

mediaType - The media type of the document

Returns:

the index document options

dryRun

public IndexDocumentOptions.Builder dryRun(java.lang.Boolean dryRun)

Sets the dryRun flag.

Parameters:

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

Returns:

the index document options

indexConfiguration

public IndexDocumentOptions.Builder indexConfiguration(IndexConfiguration indexConfiguration)

Sets the retrieve and rank configuration.

Parameters:

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

Returns:

the index document options

mediaType

public IndexDocumentOptions.Builder mediaType(java.lang.String mediaType)

Sets the media type.

Parameters:

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

Returns:

the index document options

metadata

public IndexDocumentOptions.Builder metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Sets the metadata.

Parameters:

metadata - The metadata of the document that will be indexed

Returns:

the index document options