com.ibm.watson.discovery.v2.model

Class PushBatchesOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.PushBatchesOptions

All Implemented Interfaces:

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

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

The pushBatches options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	batchId() Gets the batchId.
String	collectionId() Gets the collectionId.
InputStream	file() Gets the file.
String	filename() Gets the filename.
PushBatchesOptions.Builder	newBuilder() New builder.
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 PushBatchesOptions.Builder newBuilder()

New builder.

Returns:

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

batchId

public String batchId()

Gets the batchId.

The Universally Unique Identifier (UUID) of the document batch that is being requested from Discovery.

Returns:

the batchId

file

public InputStream file()

Gets the file.

A compressed newline-delimited JSON (NDJSON), which is a JSON file with one row of data per line. For example, `{batch_id}.ndjson.gz`. For more information, see [Binary attachment in the push batches method](/docs/discovery-data?topic=discovery-data-external-enrichment#binary-attachment-push-batches).

There is no limitation on the name of the file because Discovery does not use the name for processing. The list of features in the document is specified in the `features` object.

Returns:

the file

filename

public String filename()

Gets the filename.

The filename for file.

Returns:

the filename