com.ibm.watson.discovery.v2.model

Class CreateCollectionOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.CreateCollectionOptions

All Implemented Interfaces:

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

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

The createCollection options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	description() Gets the description.
List<CollectionEnrichment>	enrichments() Gets the enrichments.
String	language() Gets the language.
String	name() Gets the name.
CreateCollectionOptions.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 CreateCollectionOptions.Builder newBuilder()

New builder.

Returns:

a CreateCollectionOptions 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

name

public String name()

Gets the name.

The name of the collection.

Returns:

the name

description

public String description()

Gets the description.

A description of the collection.

Returns:

the description

language

public String language()

Gets the language.

The language of the collection. For a list of supported languages, see the [product documentation](/docs/discovery-data?topic=discovery-data-language-support).

Returns:

the language

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. To get a list of enrichments that are available for a project, use the [List enrichments](#listenrichments) method.

If no enrichments are specified when the collection is created, the default enrichments for the project type are applied. For more information about project default settings, see the [product documentation](/docs/discovery-data?topic=discovery-data-project-defaults).

Returns:

the enrichments