IBM InfoSphere Streams Version 4.1.1
Operator output port
This element resource provides access to information about an output port for a specific operator.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/jobs/{restid}/operators/{restid}/outputports/{restid} Properties
This element resource has the
following properties:
- connections
- A string that identifies the URI that you can use to access information about the operator connections for the output port.
- export
- An object that contains information about the stream that is exported
by this port. This property is present only if the port exports its
stream. Each export object has the following
properties:
- filterAllowed
- A boolean value that indicates whether importers of the stream are allowed to filter the exported data.
- name
- A string value that identifies the name that is used for the exported stream. This property is only present when the type property value is name.
- operator
- A string that identifies the name of the operator that is exporting the stream.
- properties
- An array of stream property objects that are associated with the
exported stream. This array is only present when the type property
value is properties. Each object contains the following
properties:
- name
- A string array that identifies the property names.
- type
- A string property that identifies the SPL type of the stream property.
- values
- An array of strings that contain the values of the stream property.
- type
- A string that identifies how the stream is exported. Some possible values for this property include name, properties, and unknown.
- indexWithinOperator
- A number that represents the index of the output port within the operator. By default, when you retrieve a collection of operator output port resources, they are sorted according to this property value.
- job
- A string that identifies the URI that you can use to access information about the job that contains the operator.
- metrics
- A string that identifies the URI that you can use to access information about the metrics that pertain to the output port.
- name
- A string that identifies the name of the output port.
- operator
- A string that identifies the URI that you can use to access information about the operator that contains the output port.
- pe
- A string that identifies the URI that you can use to access information about the processing element that contains the operator.
- peOutputPorts
- A string that identifies the URI that you can use to access information about the processing element output ports that are associated with this operator output port.
- resourceType
- A string that identifies the REST resource type, which in this case is operatorOutputPort.
- restid
- A string that represents the identifier that is used in combination with the job and operator restid property values to uniquely identify the operator output port within a URI. The value of this property is the same as the value of the indexWithinOperator property.
- self
- A string that identifies the URI for this resource.
- streamName
- A string that identifies the name of the stream that is associated with this output port.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This element resource supports the standard query parameters for element resources.