com.ibm.watson.discovery.v1.model

Class Collection

java.lang.Object

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

com.ibm.watson.discovery.v1.model.Collection

All Implemented Interfaces:

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

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

A collection for storing documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Collection.Status The status of the collection.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.lang.String	configurationId
protected CollectionCrawlStatus	crawlStatus
protected java.util.Date	created
protected java.lang.String	description
protected CollectionDiskUsage	diskUsage
protected DocumentCounts	documentCounts
protected java.lang.String	language
protected java.lang.String	name
protected SduStatus	smartDocumentUnderstanding
protected java.lang.String	status
protected TrainingStatus	trainingStatus
protected java.util.Date	updated

Constructor Summary

Constructors

Constructor and Description
Collection()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCollectionId() Gets the collectionId.
java.lang.String	getConfigurationId() Gets the configurationId.
CollectionCrawlStatus	getCrawlStatus() Gets the crawlStatus.
java.util.Date	getCreated() Gets the created.
java.lang.String	getDescription() Gets the description.
CollectionDiskUsage	getDiskUsage() Gets the diskUsage.
DocumentCounts	getDocumentCounts() Gets the documentCounts.
java.lang.String	getLanguage() Gets the language.
java.lang.String	getName() Gets the name.
SduStatus	getSmartDocumentUnderstanding() Gets the smartDocumentUnderstanding.
java.lang.String	getStatus() Gets the status.
TrainingStatus	getTrainingStatus() Gets the trainingStatus.
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

collectionId

@SerializedName(value="collection_id")
protected java.lang.String collectionId

name

protected java.lang.String name

description

protected java.lang.String description

created

protected java.util.Date created

updated

protected java.util.Date updated

status

protected java.lang.String status

configurationId

@SerializedName(value="configuration_id")
protected java.lang.String configurationId

language

protected java.lang.String language

documentCounts

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

diskUsage

@SerializedName(value="disk_usage")
protected CollectionDiskUsage diskUsage

trainingStatus

@SerializedName(value="training_status")
protected TrainingStatus trainingStatus

crawlStatus

@SerializedName(value="crawl_status")
protected CollectionCrawlStatus crawlStatus

smartDocumentUnderstanding

@SerializedName(value="smart_document_understanding")
protected SduStatus smartDocumentUnderstanding

Constructor Detail

Collection

public Collection()

Method Detail

getCollectionId

public java.lang.String getCollectionId()

Gets the collectionId.

The unique identifier of the collection.

Returns:

the collectionId

getName

public java.lang.String getName()

Gets the name.

The name of the collection.

Returns:

the name

getDescription

public java.lang.String getDescription()

Gets the description.

The description of the collection.

Returns:

the description

getCreated

public java.util.Date getCreated()

Gets the created.

The creation date of the collection in the format yyyy-MM-dd'T'HH:mmcon:ss.SSS'Z'.

Returns:

the created

getUpdated

public java.util.Date getUpdated()

Gets the updated.

The timestamp of when the collection was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

Returns:

the updated

getStatus

public java.lang.String getStatus()

Gets the status.

The status of the collection.

Returns:

the status

getConfigurationId

public java.lang.String getConfigurationId()

Gets the configurationId.

The unique identifier of the collection's configuration.

Returns:

the configurationId

getLanguage

public java.lang.String getLanguage()

Gets the language.

The language of the documents stored in the collection. Permitted values include `en` (English), `de` (German), and `es` (Spanish).

Returns:

the language

getDocumentCounts

public DocumentCounts getDocumentCounts()

Gets the documentCounts.

Object containing collection document count information.

Returns:

the documentCounts

getDiskUsage

public CollectionDiskUsage getDiskUsage()

Gets the diskUsage.

Summary of the disk usage statistics for this collection.

Returns:

the diskUsage

getTrainingStatus

public TrainingStatus getTrainingStatus()

Gets the trainingStatus.

Training status details.

Returns:

the trainingStatus

getCrawlStatus

public CollectionCrawlStatus getCrawlStatus()

Gets the crawlStatus.

Object containing information about the crawl status of this collection.

Returns:

the crawlStatus

getSmartDocumentUnderstanding

public SduStatus getSmartDocumentUnderstanding()

Gets the smartDocumentUnderstanding.

Object containing smart document understanding information for this collection.

Returns:

the smartDocumentUnderstanding