com.ibm.streamsx.topology.context

Interface ContextProperties

public interface ContextProperties

Properties that can be specified when submitting the topology to a context.

See Also:

StreamsContext.submit(com.ibm.streamsx.topology.Topology, java.util.Map), JobProperties

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_DIR Location of the generated application directory when creating a Streams application bundle.
static java.lang.String	COMPILE_INSTALL_DIR Override IBM Streams install directory for bundle compilation, defaults to $STREAMS_INSTALL.
static java.lang.String	FORCE_REMOTE_BUILD Flag to be supplied to force the compilation to occur on a Bluemix instance, if possible.
static java.lang.String	KEEP_ARTIFACTS Keep any intermediate artifacts.
static java.lang.String	SUBMISSION_PARAMS Submission parameters to be supplied to the topology when submitted for DISTRIBUTED, STANDALONE or ANALYTIC_SERVICE execution.
static java.lang.String	TOOLKIT_DIR Location of the generated toolkit root.
static java.lang.String	TRACING_LEVEL Trace level for a StreamsContext.Type.DISTRIBUTED or StreamsContext.Type.STANDALONE application.
static java.lang.String	VMARGS Java virtual machine arguments.

Field Detail

APP_DIR

static final java.lang.String APP_DIR

Location of the generated application directory when creating a Streams application bundle. If not supplied to the in the configuration passed into StreamsContext.submit(com.ibm.streamsx.topology.Topology, java.util.Map) then a unique location will be used, and placed into the configuration with this key. The value should be a String that is the absolute path of the application directory.

See Also:

Constant Field Values

TOOLKIT_DIR

static final java.lang.String TOOLKIT_DIR

Location of the generated toolkit root. If not supplied to the in the configuration passed into StreamsContext.submit(com.ibm.streamsx.topology.Topology, java.util.Map) then a unique location will be used, and placed into the configuration with this key. The value should be a String that is the absolute path of the toolkit directory.

See Also:

Constant Field Values

VMARGS

static final java.lang.String VMARGS

Java virtual machine arguments. These arguments are added to all invocations of Java virtual machines for the topology. For any SPL invoked operators the invocation must have been through methods in JavaPrimitive.
Setting the classpath is not supported.

For example, setting the maximum heap memory to 2GB:

 
    List<String> vmArgs = new ArrayList<>();
    vmArgs.add("-Xmx2048m");
    config.put(ContextProperties.VMARGS, vmArgs);
 
 

Argument is a List<String>.

See Also:

Constant Field Values

KEEP_ARTIFACTS

static final java.lang.String KEEP_ARTIFACTS

Keep any intermediate artifacts. By default intermediate artifacts are deleted after submission of a topology. For example when create an IBM Streams application bundle the intermediate SPL code and toolkit are deleted. Keeping the artifacts can aid in debugging. Argument is a Boolean.

See Also:

Constant Field Values

TRACING_LEVEL

static final java.lang.String TRACING_LEVEL

Trace level for a StreamsContext.Type.DISTRIBUTED or StreamsContext.Type.STANDALONE application. Value is an instance of java.util.logging.Level including instances of com.ibm.streams.operator.logging.TraceLevel.

See Also:

Constant Field Values

COMPILE_INSTALL_DIR

static final java.lang.String COMPILE_INSTALL_DIR

Override IBM Streams install directory for bundle compilation, defaults to $STREAMS_INSTALL. Argument is a String.

See Also:

Constant Field Values

SUBMISSION_PARAMS

static final java.lang.String SUBMISSION_PARAMS

Submission parameters to be supplied to the topology when submitted for DISTRIBUTED, STANDALONE or ANALYTIC_SERVICE execution.

The property value is a Map<String,Object> where the key is the parameter name and the value is the parameter value.

e.g.,

 Supplier<Integer> topology.createSubmissionParameter("p1", 5);
 ...
 
 ContextProperties config = new HashMap<>();
 Map<String,Object> params = new HashMap<>();
 params.put("p1", 10);
 config.put(SUBMISSION_PARAMS, params);
 
 ... StreamsContextFactory.getStreamsContext(DISTRIBUTED)
              .submit(topology, config);
 

See Topology.createSubmissionParameter(String, Class)

See Also:

Constant Field Values

FORCE_REMOTE_BUILD

static final java.lang.String FORCE_REMOTE_BUILD

Flag to be supplied to force the compilation to occur on a Bluemix instance, if possible. Currently only be used in conjunction with the ANALYTICS_SERVICE context.

Its values can be true and false. If true, it will force remote compilation when possible. If false (or unset), the parameter will have no impact.

If the FORCE_REMOTE parameter is supplied with a value of true, the SERVICE_NAME and VCAP_SERVICES parameters must also supplied. Otherwise, an error will be thrown.

See Also:

Constant Field Values