com.ibm.streamsx.topology.context

Interface Placeable<T extends Placeable<T>>

All Superinterfaces:

TopologyElement

All Known Subinterfaces:

SPLStream, TSink, TStream<T>

public interface Placeable<T extends Placeable<T>>
extends TopologyElement

Placement directives for a topology element when executing in a distributed runtime.
Placement directives only apply when the topology is submitted to a DISTRIBUTED, ANALYTICS_SERVICE or DISTRIBUTED_TESTER context.
For all other context types directives are ignored.

Method Summary

Modifier and Type	Method and Description
T	addResourceTags(java.lang.String... tags) Add required resource tags for this topology element for distributed submission.
T	colocate(Placeable<?>... elements) Colocate this element with other topology elements so that at runtime they all execute within the same operating system process.
java.util.Set<java.lang.String>	getResourceTags() Get the set of resource tags this element requires.
boolean	isPlaceable() Can this element have placement directives applied to it.
com.ibm.streamsx.topology.builder.BOperatorInvocation	operator()

Methods inherited from interface com.ibm.streamsx.topology.TopologyElement

builder, graph, topology

Method Detail

isPlaceable

boolean isPlaceable()

Can this element have placement directives applied to it.

Returns:

true if placement directives can be assigned, false if it can not.

colocate

T colocate(Placeable<?>... elements)

Colocate this element with other topology elements so that at runtime they all execute within the same operating system process. elements may contain any Placeable within the same topology, there is no requirement that the element is connected (by a stream) directly or indirectly to this element.

Parameters:

elements - Elements to colocate with this container.

Returns:

this

Throws:

IllegalStateExeception - Any element including this returns false for isPlaceable().

addResourceTags

T addResourceTags(java.lang.String... tags)

Add required resource tags for this topology element for distributed submission. This topology element and any it has been colocated with will execute on a resource (host) that has all the tags returned by getResourceTags().

Parameters:

tags - Tags to be required at runtime.

Returns:

this

getResourceTags

java.util.Set<java.lang.String> getResourceTags()

Get the set of resource tags this element requires. If this topology element has been colocated with other topology elements then the returned set is the union of all resource tags added to each colocated element.

Returns:

Read-only set of host tags this element requires.

operator

com.ibm.streamsx.topology.builder.BOperatorInvocation operator()