com.ibm.watson.compare_comply.v1.model

Class CreateBatchOptions

java.lang.Object

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

com.ibm.watson.compare_comply.v1.model.CreateBatchOptions

All Implemented Interfaces:

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

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

The createBatch options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateBatchOptions.Builder Builder.
static interface	CreateBatchOptions.Function The Compare and Comply method to run across the submitted input documents.
static interface	CreateBatchOptions.Model The analysis model to be used by the service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	function
protected java.lang.String	inputBucketLocation
protected java.lang.String	inputBucketName
protected java.io.InputStream	inputCredentialsFile
protected java.lang.String	model
protected java.lang.String	outputBucketLocation
protected java.lang.String	outputBucketName
protected java.io.InputStream	outputCredentialsFile

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	function() Gets the function.
java.lang.String	inputBucketLocation() Gets the inputBucketLocation.
java.lang.String	inputBucketName() Gets the inputBucketName.
java.io.InputStream	inputCredentialsFile() Gets the inputCredentialsFile.
java.lang.String	model() Gets the model.
CreateBatchOptions.Builder	newBuilder() New builder.
java.lang.String	outputBucketLocation() Gets the outputBucketLocation.
java.lang.String	outputBucketName() Gets the outputBucketName.
java.io.InputStream	outputCredentialsFile() Gets the outputCredentialsFile.

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

function

protected java.lang.String function

inputCredentialsFile

protected java.io.InputStream inputCredentialsFile

inputBucketLocation

protected java.lang.String inputBucketLocation

inputBucketName

protected java.lang.String inputBucketName

outputCredentialsFile

protected java.io.InputStream outputCredentialsFile

outputBucketLocation

protected java.lang.String outputBucketLocation

outputBucketName

protected java.lang.String outputBucketName

model

protected java.lang.String model

Constructor Detail

CreateBatchOptions

protected CreateBatchOptions(CreateBatchOptions.Builder builder)

Method Detail

newBuilder

public CreateBatchOptions.Builder newBuilder()

New builder.

Returns:

a CreateBatchOptions builder

function

public java.lang.String function()

Gets the function.

The Compare and Comply method to run across the submitted input documents.

Returns:

the function

inputCredentialsFile

public java.io.InputStream inputCredentialsFile()

Gets the inputCredentialsFile.

A JSON file containing the input Cloud Object Storage credentials. At a minimum, the credentials must enable `READ` permissions on the bucket defined by the `input_bucket_name` parameter.

Returns:

the inputCredentialsFile

inputBucketLocation

public java.lang.String inputBucketLocation()

Gets the inputBucketLocation.

The geographical location of the Cloud Object Storage input bucket as listed on the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.

Returns:

the inputBucketLocation

inputBucketName

public java.lang.String inputBucketName()

Gets the inputBucketName.

The name of the Cloud Object Storage input bucket.

Returns:

the inputBucketName

outputCredentialsFile

public java.io.InputStream outputCredentialsFile()

Gets the outputCredentialsFile.

A JSON file that lists the Cloud Object Storage output credentials. At a minimum, the credentials must enable `READ` and `WRITE` permissions on the bucket defined by the `output_bucket_name` parameter.

Returns:

the outputCredentialsFile

outputBucketLocation

public java.lang.String outputBucketLocation()

Gets the outputBucketLocation.

The geographical location of the Cloud Object Storage output bucket as listed on the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.

Returns:

the outputBucketLocation

outputBucketName

public java.lang.String outputBucketName()

Gets the outputBucketName.

The name of the Cloud Object Storage output bucket.

Returns:

the outputBucketName

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