Package com.ibm.watson.discovery.v1.model

Class UpdateDocumentOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.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	Description
static class	UpdateDocumentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	collectionId()	Gets the collectionId.
String	documentId()	Gets the documentId.
String	environmentId()	Gets the environmentId.
InputStream	file()	Gets the file.
String	fileContentType()	Gets the fileContentType.
String	filename()	Gets the filename.
String	metadata()	Gets the metadata.
UpdateDocumentOptions.Builder	newBuilder()	New builder.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public UpdateDocumentOptions.Builder newBuilder()

New builder.

Returns:

a UpdateDocumentOptions builder

environmentId

public String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

documentId

public String documentId()

Gets the documentId.

The ID of the document.

Returns:

the documentId

file

public 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 String filename()

Gets the filename.

The filename for file.

Returns:

the filename

fileContentType

public 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 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