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

Interface CollectionManager

All Known Implementing Classes:

Discovery

public interface CollectionManager

Interface defining the constants and methods associated with Collections.

See Also:

Collection

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVAILABLE
static String	COLLECTIONS
static String	CONFIGURATION_ID
static String	CREATED
static String	DESCRIPTION
static String	DOCUMENT_COUNTS
static String	FAILED
static String	FIELD
static String	FIELDS
static String	ID
static String	LANGUAGE
static String	NAME
static String	PROCESSING
static String	STATUS
static String	TYPE
static String	UPDATED

Method Summary

Modifier and Type	Method and Description
ServiceCall<CreateCollectionResponse>	createCollection(CreateCollectionRequest createRequest) Creates a Collection.
ServiceCall<DeleteCollectionResponse>	deleteCollection(DeleteCollectionRequest deleteRequest) Deletes a Collection.
ServiceCall<GetCollectionResponse>	getCollection(GetCollectionRequest getRequest) Gets a Collection.
ServiceCall<GetCollectionFieldsResponse>	getCollectionFields(GetCollectionFieldsRequest getRequest) Gets a list of unique Fields from a Collection.
ServiceCall<GetCollectionsResponse>	getCollections(GetCollectionsRequest getRequest) Gets a list of Collection.

Field Detail

COLLECTIONS

static final String COLLECTIONS

See Also:

Constant Field Values

ID

static final String ID

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

CREATED

static final String CREATED

See Also:

Constant Field Values

UPDATED

static final String UPDATED

See Also:

Constant Field Values

STATUS

static final String STATUS

See Also:

Constant Field Values

CONFIGURATION_ID

static final String CONFIGURATION_ID

See Also:

Constant Field Values

LANGUAGE

static final String LANGUAGE

See Also:

Constant Field Values

DOCUMENT_COUNTS

static final String DOCUMENT_COUNTS

See Also:

Constant Field Values

AVAILABLE

static final String AVAILABLE

See Also:

Constant Field Values

PROCESSING

static final String PROCESSING

See Also:

Constant Field Values

FAILED

static final String FAILED

See Also:

Constant Field Values

FIELDS

static final String FIELDS

See Also:

Constant Field Values

FIELD

static final String FIELD

See Also:

Constant Field Values

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

getCollections

ServiceCall<GetCollectionsResponse> getCollections(GetCollectionsRequest getRequest)

Gets a list of Collection. An optional parameter of name can be provided to filter by name.

Parameters:

getRequest - options for getting the Collections

Returns:

a GetCollectionsResponse containing the result of GetCollectionsRequest

getCollection

ServiceCall<GetCollectionResponse> getCollection(GetCollectionRequest getRequest)

Gets a Collection.

Parameters:

getRequest - options for getting the Collection

Returns:

a GetCollectionResponse containing the result of GetCollectionRequest

createCollection

ServiceCall<CreateCollectionResponse> createCollection(CreateCollectionRequest createRequest)

Creates a Collection.

Parameters:

createRequest - options for creating a Collection

Returns:

a CreateCollectionResponse containing the result of CreateCollectionRequest

deleteCollection

ServiceCall<DeleteCollectionResponse> deleteCollection(DeleteCollectionRequest deleteRequest)

Deletes a Collection.

Parameters:

deleteRequest - options for deleting a Collection

Returns:

a DeleteCollectionResponse containing the result of DeleteCollectionRequest

getCollectionFields

ServiceCall<GetCollectionFieldsResponse> getCollectionFields(GetCollectionFieldsRequest getRequest)

Gets a list of unique Fields from a Collection.

Parameters:

getRequest - options for getting a unique fields from a Collection

Returns:

a GetCollectionFieldsResponse containing the result of GetCollectionFieldsRequest