AnalyzeDocumentOptions (IBM Watson Java SDK 9.2.1 API)

java.lang.Object

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

com.ibm.watson.discovery.v2.model.AnalyzeDocumentOptions

All Implemented Interfaces:: com.ibm.cloud.sdk.core.service.model.ObjectModel

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

The analyzeDocument options.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AnalyzeDocumentOptions.Builder
Builder.

Method Summary

Modifier and Type	Method	Description
`String`	`collectionId()`	Gets the collectionId.
`InputStream`	`file()`	Gets the file.
`String`	`fileContentType()`	Gets the fileContentType.
`String`	`filename()`	Gets the filename.
`String`	`metadata()`	Gets the metadata.
`AnalyzeDocumentOptions.Builder`	`newBuilder()`	New builder.
`String`	`projectId()`	Gets the projectId.

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 AnalyzeDocumentOptions.Builder newBuilder()
  
  New builder.
  
  Returns:
  
  a AnalyzeDocumentOptions builder
- projectId
  
  public 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 String collectionId()
  
  Gets the collectionId.
  The ID of the collection.
  
  Returns:
  
  the collectionId
- 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