Operator HTTPGetStream
SPL standard and specialized toolkits > com.ibm.streamsx.inet 2.0.1 > com.ibm.streamsx.inet.http > HTTPGetStream
Connects to an HTTP endpoint, reads "chunks" of data and sends it to the output port. Every line read from the HTTP server endpoint is sent as a single tuple. If a connection is closed by the server, a WINDOW punctuation will be sent on port 0. Supported Authentications: Basic Authentication, OAuth 1.0a. Supported Compressions: Gzip, Deflate.
Behavior in a consistent region
This operator cannot be used inside a consistent region.
Summary
- Ports
- This operator has 0 input port and 2 output ports.
- Windowing
- This operator does not accept any windowing configurations.
- Parameters
- This operator supports 11 parameters. (authenticationFile, authenticationProperty, authenticationType, backoff, dataAttributeName, disableCompression, maxRetries, postData, retryDelay, retryOnClose, url)
- Metrics
- This operator does not report any metrics.
Properties
- Implementation
- Java™
- Assignments
- Java operators do not support output assignments.
- Ports (0)
-
Data received from the server will be sent on this port.
- Properties
-
- Optional: false
- WindowPunctuationOutputMode: Generating
- Ports (1)
-
Error information will be sent out on this port including the response code and any message recieved from the server. Tuple structure must conform to the HTTPResponse type specified in this namespace.
- Properties
-
- Optional: true
- authenticationFile
Path to the properties file containing authentication information. Authentication file is recommended to be stored in the application_dir/etc directory. Path of this file can be absolute or relative, if relative path is specified then it is relative to the application directory. See http_auth_basic.properties in the toolkits etc directory for a sample of basic authentication properties.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- authenticationProperty
Properties to override those in the authentication file.
- authenticationType
Valid options are "oauth", "basic" and "none". Default is "none". If the "oauth" option is selected, the requests will be singed using OAuth 1.0a.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- backoff
Use a backoff function for increasing the wait time between retries. Wait times increase by a factor of 10. Default is false
- Properties
-
- Type: boolean
- Cardinality: 1
- Optional: true
- dataAttributeName
Name of the attribute to populate the response data with. Default is "data"
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- disableCompression
By default the client will ask the server to compress its reponse data using supported compressions (gzip, deflate). Setting this option to true will disable compressions. Default is false.
- Properties
-
- Type: boolean
- Cardinality: 1
- Optional: true
- maxRetries
Maximum number of retries in case of failures/disconnects.
- Properties
-
- Type: int32
- Cardinality: 1
- Optional: true
- postData
The value for this parameter will be sent to the server as a POST request body. The value is expected to be in "key=value" format.
- retryDelay
Wait time between retries in case of failures/disconnects.
- Properties
-
- Type: float64
- Cardinality: 1
- Optional: true
- retryOnClose
Retry connecting if the connection has been closed. Default is false
- Properties
-
- Type: boolean
- Cardinality: 1
- Optional: true
- url
URL endpoint to connect to.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: false
- Operator class library
- Library Path: ../../impl/lib/com.ibm.streamsx.inet.jar, ../../opt/downloaded/*