com.ibm.watson.developer_cloud.discovery.v1.model

Class Collection

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

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

All Implemented Interfaces:

ObjectModel

public class Collection
extends 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.

Constructor Summary

Constructors

Constructor and Description
Collection()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionId() Gets the collectionId.
java.lang.String	getConfigurationId() Gets the configurationId.
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.
java.lang.String	getStatus() Gets the status.
TrainingStatus	getTrainingStatus() Gets the trainingStatus.
java.util.Date	getUpdated() Gets the updated.
void	setConfigurationId(java.lang.String configurationId) Sets the configurationId.
void	setDescription(java.lang.String description) Sets the description.
void	setDiskUsage(CollectionDiskUsage diskUsage) Sets the diskUsage.
void	setDocumentCounts(DocumentCounts documentCounts) Sets the documentCounts.
void	setLanguage(java.lang.String language) Sets the language.
void	setName(java.lang.String name) Sets the name.
void	setTrainingStatus(TrainingStatus trainingStatus) Sets the trainingStatus.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

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_us` (U.S. English), `de` (German), and `es` (Spanish).

Returns:

the language

getDocumentCounts

public DocumentCounts getDocumentCounts()

Gets the documentCounts. The object providing information about the documents in the collection. Present only when retrieving details of a collection.

Returns:

the documentCounts

getDiskUsage

public CollectionDiskUsage getDiskUsage()

Gets the diskUsage. The object providing information about the disk usage of the collection. Present only when retrieving details of a collection.

Returns:

the diskUsage

getTrainingStatus

public TrainingStatus getTrainingStatus()

Gets the trainingStatus. Provides information about the status of relevance training for collection.

Returns:

the trainingStatus

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the new description

setConfigurationId

public void setConfigurationId(java.lang.String configurationId)

Sets the configurationId.

Parameters:

configurationId - the new configurationId

setLanguage

public void setLanguage(java.lang.String language)

Sets the language.

Parameters:

language - the new language

setDocumentCounts

public void setDocumentCounts(DocumentCounts documentCounts)

Sets the documentCounts.

Parameters:

documentCounts - the new documentCounts

setDiskUsage

public void setDiskUsage(CollectionDiskUsage diskUsage)

Sets the diskUsage.

Parameters:

diskUsage - the new diskUsage

setTrainingStatus

public void setTrainingStatus(TrainingStatus trainingStatus)

Sets the trainingStatus.

Parameters:

trainingStatus - the new trainingStatus