IBM Streams 4.3.0
Processing element connection
This element resource provides access to information about a connection between two processing element (PE) ports.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/peconnections/{restid}Properties
This element resource has the
following properties:
- id
- A string that uniquely identifies the PE connection within the instance. The value of this property is generated from the output and input port indexes and the PE IDs.
- metrics
- A string that identifies the URI that you can use to access information about the metrics for the connection.
- required
- A boolean value that indicates whether the connection is required.
- resourceType
- A string that identifies the REST resource type, which is peConnection.
- restid
- A string that represents an identifier that uniquely identifies the PE connection within a URI. The value of this property is the same as the value of the id property.
- self
- A string that identifies the URI for this resource.
- source
- An object that contains the following properties for the connection
source:
- job
- A string that identifies the URI that you can use to access information about the job that is the source of the connection.
- outputPort
- A string that identifies the URI that you can use to access information about the output port that is the source of the connection.
- pe
- A string that identifies the URI that you can use to access information about the processing element that is the source of the connection.
- target
- An object that contains the following properties for the connection
target:
- inputPort
- A string that identifies the URI that you can use to access information about the input port that is the target of the connection.
- job
- A string that identifies the URI that you can use to access information about the job that is the target of the connection.
- pe
- A string that identifies the URI that you can use to access information about the processing element that is the target of the connection.
- status
- A string that identifies the status of the connection. Some possible values for this property include initial, connecting, connected, disconnected, closed, and unknown.
Note: By default, when you retrieve a collection
of PE connection resources, they are not sorted.
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.