com.ibm.watson.compare_comply.v1.model

Class UpdateBatchOptions

java.lang.Object

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

com.ibm.watson.compare_comply.v1.model.UpdateBatchOptions

All Implemented Interfaces:

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

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

The updateBatch options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateBatchOptions.Action The action you want to perform on the specified batch-processing job.
static class	UpdateBatchOptions.Builder Builder.
static interface	UpdateBatchOptions.Model The analysis model to be used by the service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	action
protected java.lang.String	batchId
protected java.lang.String	model

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	action() Gets the action.
java.lang.String	batchId() Gets the batchId.
java.lang.String	model() Gets the model.
UpdateBatchOptions.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

batchId

protected java.lang.String batchId

action

protected java.lang.String action

model

protected java.lang.String model

Constructor Detail

UpdateBatchOptions

protected UpdateBatchOptions(UpdateBatchOptions.Builder builder)

Method Detail

newBuilder

public UpdateBatchOptions.Builder newBuilder()

New builder.

Returns:

a UpdateBatchOptions builder

batchId

public java.lang.String batchId()

Gets the batchId.

The ID of the batch-processing job you want to update.

Returns:

the batchId

action

public java.lang.String action()

Gets the action.

The action you want to perform on the specified batch-processing job.

Returns:

the action

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