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 and Description
static interface	BatchStatus.Function The method to be run against the documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	batchId
protected java.util.Date	created
protected DocCounts	documentCounts
protected java.lang.String	function
protected java.lang.String	inputBucketLocation
protected java.lang.String	inputBucketName
protected java.lang.String	outputBucketLocation
protected java.lang.String	outputBucketName
protected java.lang.String	status
protected java.util.Date	updated

Constructor Summary

Constructors

Constructor and Description
BatchStatus()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBatchId() Gets the batchId.
java.util.Date	getCreated() Gets the created.
DocCounts	getDocumentCounts() Gets the documentCounts.
java.lang.String	getFunction() Gets the function.
java.lang.String	getInputBucketLocation() Gets the inputBucketLocation.
java.lang.String	getInputBucketName() Gets the inputBucketName.
java.lang.String	getOutputBucketLocation() Gets the outputBucketLocation.
java.lang.String	getOutputBucketName() Gets the outputBucketName.
java.lang.String	getStatus() Gets the status.
java.util.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

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

Field Detail

function

protected java.lang.String function

inputBucketLocation

@SerializedName(value="input_bucket_location")
protected java.lang.String inputBucketLocation

inputBucketName

@SerializedName(value="input_bucket_name")
protected java.lang.String inputBucketName

outputBucketLocation

@SerializedName(value="output_bucket_location")
protected java.lang.String outputBucketLocation

outputBucketName

@SerializedName(value="output_bucket_name")
protected java.lang.String outputBucketName

batchId

@SerializedName(value="batch_id")
protected java.lang.String batchId

documentCounts

@SerializedName(value="document_counts")
protected DocCounts documentCounts

status

protected java.lang.String status

created

protected java.util.Date created

updated

protected java.util.Date updated

Constructor Detail

BatchStatus

public BatchStatus()

Method Detail

getFunction

public java.lang.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 java.lang.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 java.lang.String getInputBucketName()

Gets the inputBucketName.

The name of the Cloud Object Storage input bucket.

Returns:

the inputBucketName

getOutputBucketLocation

public java.lang.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 java.lang.String getOutputBucketName()

Gets the outputBucketName.

The name of the Cloud Object Storage output bucket.

Returns:

the outputBucketName

getBatchId

public java.lang.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 java.lang.String getStatus()

Gets the status.

The status of the batch request.

Returns:

the status

getCreated

public java.util.Date getCreated()

Gets the created.

The creation time of the batch request.

Returns:

the created

getUpdated

public java.util.Date getUpdated()

Gets the updated.

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

Returns:

the updated