com.ibm.watson.discovery.v1.model

Class TestConfigurationInEnvironmentOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.model.TestConfigurationInEnvironmentOptions

All Implemented Interfaces:

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

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

The testConfigurationInEnvironment options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestConfigurationInEnvironmentOptions.Builder Builder.
static interface	TestConfigurationInEnvironmentOptions.Step Specify to only run the input document through the given step instead of running the input document through the entire ingestion workflow.

Method Summary

Modifier and Type	Method and Description
java.lang.String	configuration() Gets the configuration.
java.lang.String	configurationId() Gets the configurationId.
java.lang.String	environmentId() Gets the environmentId.
java.io.InputStream	file() Gets the file.
java.lang.String	fileContentType() Gets the fileContentType.
java.lang.String	filename() Gets the filename.
java.lang.String	metadata() Gets the metadata.
TestConfigurationInEnvironmentOptions.Builder	newBuilder() New builder.
java.lang.String	step() Gets the step.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public TestConfigurationInEnvironmentOptions.Builder newBuilder()

New builder.

Returns:

a TestConfigurationInEnvironmentOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId. The ID of the environment.

Returns:

the environmentId

configuration

public java.lang.String configuration()

Gets the configuration. The configuration to use to process the document. If this part is provided, then the provided configuration is used to process the document. If the **configuration_id** is also provided (both are present at the same time), then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are rejected. See the `GET /configurations/{configuration_id}` operation for an example configuration.

Returns:

the configuration

file

public java.io.InputStream file()

Gets the file. The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a confiruration is 1 megabyte. Files larger than the supported size are rejected.

Returns:

the file

filename

public java.lang.String filename()

Gets the filename. The filename for file.

Returns:

the filename

fileContentType

public java.lang.String fileContentType()

Gets the fileContentType. The content type of file. Values for this parameter can be obtained from the HttpMediaType class.

Returns:

the fileContentType

metadata

public java.lang.String metadata()

Gets the metadata. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: ``` { "Creator": "Johnny Appleseed", "Subject": "Apples" } ```.

Returns:

the metadata

step

public java.lang.String step()

Gets the step. Specify to only run the input document through the given step instead of running the input document through the entire ingestion workflow. Valid values are `convert`, `enrich`, and `normalize`.

Returns:

the step

configurationId

public java.lang.String configurationId()

Gets the configurationId. The ID of the configuration to use to process the document. If the **configuration** form part is also provided (both are present at the same time), then the request will be rejected.

Returns:

the configurationId