com.ibm.watson.discovery.v2.model

Class UpdateDocumentOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.UpdateDocumentOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateDocumentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateDocument options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.lang.String	documentId
protected java.io.InputStream	file
protected java.lang.String	fileContentType
protected java.lang.String	filename
protected java.lang.String	metadata
protected java.lang.String	projectId
protected java.lang.Boolean	xWatsonDiscoveryForce

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpdateDocumentOptions(UpdateDocumentOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	collectionId() Gets the collectionId.
java.lang.String	documentId() Gets the documentId.
java.io.InputStream	file() Gets the file.
java.lang.String	fileContentType() Gets the fileContentType.
java.lang.String	filename() Gets the filename.
java.lang.String	metadata() Gets the metadata.
UpdateDocumentOptions.Builder	newBuilder() New builder.
java.lang.String	projectId() Gets the projectId.
java.lang.Boolean	xWatsonDiscoveryForce() Gets the xWatsonDiscoveryForce.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

projectId

protected java.lang.String projectId

collectionId

protected java.lang.String collectionId

documentId

protected java.lang.String documentId

file

protected java.io.InputStream file

filename

protected java.lang.String filename

fileContentType

protected java.lang.String fileContentType

metadata

protected java.lang.String metadata

xWatsonDiscoveryForce

protected java.lang.Boolean xWatsonDiscoveryForce

Constructor Detail

UpdateDocumentOptions

protected UpdateDocumentOptions(UpdateDocumentOptions.Builder builder)

Method Detail

newBuilder

public UpdateDocumentOptions.Builder newBuilder()

New builder.

Returns:

a UpdateDocumentOptions builder

projectId

public java.lang.String projectId()

Gets the projectId.

The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Returns:

the projectId

collectionId

public java.lang.String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

documentId

public java.lang.String documentId()

Gets the documentId.

The ID of the document.

Returns:

the documentId

file

public java.io.InputStream file()

Gets the file.

The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.

Returns:

the file

filename

public java.lang.String filename()

Gets the filename.

The filename for file.

Returns:

the filename

fileContentType

public java.lang.String fileContentType()

Gets the fileContentType.

The content type of file. Values for this parameter can be obtained from the HttpMediaType class.

Returns:

the fileContentType

metadata

public java.lang.String metadata()

Gets the metadata.

The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: ``` { "Creator": "Johnny Appleseed", "Subject": "Apples" } ```.

Returns:

the metadata

xWatsonDiscoveryForce

public java.lang.Boolean xWatsonDiscoveryForce()

Gets the xWatsonDiscoveryForce.

When `true`, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Returns:

the xWatsonDiscoveryForce