Package com.ibm.watson.compare_comply.v1.model

Class BatchStatus

java.lang.Object

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

com.ibm.watson.compare_comply.v1.model.BatchStatus

All Implemented Interfaces:

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

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

The batch-request status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchStatus.Function	The method to be run against the documents.

Constructor Summary

Constructors

Constructor	Description
BatchStatus()

Method Summary

Modifier and Type	Method	Description
String	getBatchId()	Gets the batchId.
Date	getCreated()	Gets the created.
DocCounts	getDocumentCounts()	Gets the documentCounts.
String	getFunction()	Gets the function.
String	getInputBucketLocation()	Gets the inputBucketLocation.
String	getInputBucketName()	Gets the inputBucketName.
String	getOutputBucketLocation()	Gets the outputBucketLocation.
String	getOutputBucketName()	Gets the outputBucketName.
String	getStatus()	Gets the status.
Date	getUpdated()	Gets the updated.

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

Constructor Details

BatchStatus

public BatchStatus()

Method Details

getFunction

public String getFunction()

Gets the function.

The method to be run against the documents. Possible values are `html_conversion`, `element_classification`, and `tables`.

Returns:

the function

getInputBucketLocation

public String getInputBucketLocation()

Gets the inputBucketLocation.

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

Returns:

the inputBucketLocation

getInputBucketName

public String getInputBucketName()

Gets the inputBucketName.

The name of the Cloud Object Storage input bucket.

Returns:

the inputBucketName

getOutputBucketLocation

public String getOutputBucketLocation()

Gets the outputBucketLocation.

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

Returns:

the outputBucketLocation

getOutputBucketName

public String getOutputBucketName()

Gets the outputBucketName.

The name of the Cloud Object Storage output bucket.

Returns:

the outputBucketName

getBatchId

public String getBatchId()

Gets the batchId.

The unique identifier for the batch request.

Returns:

the batchId

getDocumentCounts

public DocCounts getDocumentCounts()

Gets the documentCounts.

Document counts.

Returns:

the documentCounts

getStatus

public String getStatus()

Gets the status.

The status of the batch request.

Returns:

the status

getCreated

public Date getCreated()

Gets the created.

The creation time of the batch request.

Returns:

the created

getUpdated

public Date getUpdated()

Gets the updated.

The time of the most recent update to the batch request.

Returns:

the updated