com.ibm.watson.discovery.v2.model

Class UpdateCollectionOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.UpdateCollectionOptions

All Implemented Interfaces:

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

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

The updateCollection options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateCollectionOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
String	description() Gets the description.
List<CollectionEnrichment>	enrichments() Gets the enrichments.
String	name() Gets the name.
UpdateCollectionOptions.Builder	newBuilder() New builder.
Boolean	ocrEnabled() Gets the ocrEnabled.
String	projectId() Gets the projectId.

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

Method Detail

newBuilder

public UpdateCollectionOptions.Builder newBuilder()

New builder.

Returns:

a UpdateCollectionOptions builder

projectId

public String projectId()

Gets the projectId.

The Universally Unique Identifier (UUID) of the project. This information can be found from the *Integrate and Deploy* page in Discovery.

Returns:

the projectId

collectionId

public String collectionId()

Gets the collectionId.

The Universally Unique Identifier (UUID) of the collection.

Returns:

the collectionId

name

public String name()

Gets the name.

The new name of the collection.

Returns:

the name

description

public String description()

Gets the description.

The new description of the collection.

Returns:

the description

ocrEnabled

public Boolean ocrEnabled()

Gets the ocrEnabled.

If set to `true`, optical character recognition (OCR) is enabled. For more information, see [Optical character recognition](/docs/discovery-data?topic=discovery-data-collections#ocr).

Returns:

the ocrEnabled

enrichments

public List<CollectionEnrichment> enrichments()

Gets the enrichments.

An array of enrichments that are applied to this collection.

Returns:

the enrichments