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

Class UpdateDocumentOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

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

All Implemented Interfaces:

ObjectModel

public class UpdateDocumentOptions
extends GenericModel

The updateDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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.lang.String	environmentId() Gets the environmentId.
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.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public UpdateDocumentOptions.Builder newBuilder()

New builder.

Returns:

a UpdateDocumentOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId. The ID of the environment.

Returns:

the environmentId

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 is 50 megabytes. Files larger than 50 megabytes is rejected.

Returns:

the file

filename

public java.lang.String filename()

Gets the filename. The filename for file.

Returns:

the filename

metadata

public java.lang.String metadata()

Gets the metadata. If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that the Data Crawler might send. 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

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