IBM Streams 4.3.0
Operator input port
This element resource provides access to information about an input port for a specific operator.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/jobs/{restid}/operators/{restid}/inputports/{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 input port.
- indexWithinOperator
- A number that represents the index of the input port within the operator. By default, when you retrieve a collection of operator input port resources, they are sorted according to this property value.
- import
- An object that contains the following properties for the stream
or streams that are imported by this port. This property is not present
if the port does not import any streams.
- applicationScope
- A string that identifies the application scope of the exporting application. If the application scope is not explicitly set, null is returned, and the default application scope is used. This field is not present if the import type is not subscription.
- filter
- A string that identifies the filter on the importing stream. If there is no filter, this value is null.
- names
- An array that contains information about the named based imports
for the port. Each array element is an object with the following fields. Note: The names field is not present in the import object if the import type is not name.
- applicationScope
- A string that identifies the application scope of the exporting application. If the application scope is not explicitly set, null is returned and the default scope is used.
- name
- A string that identifies the name of the imported stream.
- operator
- A string that identifies the name of the operator that is importing the stream.
- operator
- A string that identifies the import operator. This property is not present if the import type is not subscription.
- subscription
- A string that identifies the subscription value as a boolean or rstring predicate. This property is only present when import streams are matched to export streams by using subscriptions.
- type
- A string that identifies how a match to an exported stream is determined. Import streams are matched to export streams. The match can be done by subscription or by streamId name. Some possible values for this property include name, subscription, and unknown.
- 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 for the input port.
- name
- A string that identifies the name of the input port.
- operator
- A string that identifies the URI that you can use to access information about the operator that contains the input port.
- pe
- A string that identifies the URI that you can use to access information about the processing element that contains the operator.
- peInputPorts
- A string that identifies the URI that you can use to access information about the processing element input ports that are associated with this operator input port.
- resourceType
- A string that identifies the REST resource type, which in this case is operatorInputPort.
- restid
- A string that represents the identifier that is used in combination with the job and operator restid property values to uniquely identify the 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.
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.