Package 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.

  • Constructor Details

    • Collection

      public Collection()

  • Method Details

    • getCollectionId

      public String getCollectionId()
      Gets the collectionId.

      The unique identifier of the collection.

      Returns:
      the collectionId

    • getName

      public String getName()
      Gets the name.

      The name of the collection.

      Returns:
      the name

    • getDescription

      public String getDescription()
      Gets the description.

      The description of the collection.

      Returns:
      the description

    • getCreated

      public 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 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 String getStatus()
      Gets the status.

      The status of the collection.

      Returns:
      the status

    • getConfigurationId

      public String getConfigurationId()
      Gets the configurationId.

      The unique identifier of the collection's configuration.

      Returns:
      the configurationId

    • getLanguage

      public 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