com.ibm.watson.compare_comply.v1.model

Class CompareDocumentsOptions

java.lang.Object

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

com.ibm.watson.compare_comply.v1.model.CompareDocumentsOptions

All Implemented Interfaces:

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

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

The compareDocuments options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompareDocumentsOptions.Builder Builder.
static interface	CompareDocumentsOptions.Model The analysis model to be used by the service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.InputStream	file1
protected java.lang.String	file1ContentType
protected java.lang.String	file1Label
protected java.io.InputStream	file2
protected java.lang.String	file2ContentType
protected java.lang.String	file2Label
protected java.lang.String	model

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	file1() Gets the file1.
java.lang.String	file1ContentType() Gets the file1ContentType.
java.lang.String	file1Label() Gets the file1Label.
java.io.InputStream	file2() Gets the file2.
java.lang.String	file2ContentType() Gets the file2ContentType.
java.lang.String	file2Label() Gets the file2Label.
java.lang.String	model() Gets the model.
CompareDocumentsOptions.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

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

Field Detail

file1

protected java.io.InputStream file1

file2

protected java.io.InputStream file2

file1ContentType

protected java.lang.String file1ContentType

file2ContentType

protected java.lang.String file2ContentType

file1Label

protected java.lang.String file1Label

file2Label

protected java.lang.String file2Label

model

protected java.lang.String model

Constructor Detail

CompareDocumentsOptions

protected CompareDocumentsOptions(CompareDocumentsOptions.Builder builder)

Method Detail

newBuilder

public CompareDocumentsOptions.Builder newBuilder()

New builder.

Returns:

a CompareDocumentsOptions builder

file1

public java.io.InputStream file1()

Gets the file1.

The first document to compare.

Returns:

the file1

file2

public java.io.InputStream file2()

Gets the file2.

The second document to compare.

Returns:

the file2

file1ContentType

public java.lang.String file1ContentType()

Gets the file1ContentType.

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

Returns:

the file1ContentType

file2ContentType

public java.lang.String file2ContentType()

Gets the file2ContentType.

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

Returns:

the file2ContentType

file1Label

public java.lang.String file1Label()

Gets the file1Label.

A text label for the first document.

Returns:

the file1Label

file2Label

public java.lang.String file2Label()

Gets the file2Label.

A text label for the second document.

Returns:

the file2Label

model

public java.lang.String model()

Gets the model.

The analysis model to be used by the service. For the **Element classification** and **Compare two documents** methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

Returns:

the model