Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.inet 5.0.0
Namespace com.teracloud.streams.inet.http
Operator HTTPGetXMLContent

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Operator HTTPGetXMLContent

Periodically connects to an HTTP endpoint to GET XML content as a single tuple. The XML content is assigned to the first attribute in the output tuple which must be of type xml.The URL can have a single query parameter updated using the updateParameter parameter.When set the URL query string will be modified to set the named parameter to a new value.The default action is to set it to the number of milliseconds since the 1970 epoch.

Summary

Ports

This operator has 0 input ports and 1 output port.

Windowing

This operator does not accept any windowing configurations.

Parameters

This operator supports 8 parameters.

Required: url

Optional: acceptAllCertificates, extraHeaders, initDelay, iterations, period, updateParameter, updateParameterFromContent

Metrics

This operator reports 1 metric.

Properties

Implementation: Java

Output Ports

Assignments: Java operators do not support output assignments.

Ports (0)

Content of the HTTP GET request as an XML attribute. Each successful HTTP request that returns a single well-formed XML document results in a submitted tuple with an XML attribute containing the returned content.

Properties

Optional: false

WindowPunctuationOutputMode: Free

This operator supports 8 parameters.

Required: url

Optional: acceptAllCertificates, extraHeaders, initDelay, iterations, period, updateParameter, updateParameterFromContent

acceptAllCertificates

Accept all SSL certificates, even those that are self-signed. Setting this option will allow potentially insecure connections. Default is false.

Properties

Type: boolean
Cardinality: 1
Optional: true

extraHeaders

Extra headers to send with request, format is "Header-Name: value"

Properties

Type: rstring
Optional: true

initDelay

Delay in seconds before the operator starts producing tuples.

Properties

Type: int64
Cardinality: 1
Optional: true

iterations

The number of tuples to submit. Negative value or zero means continually fetch and submit tuples.

Properties

Type: int32
Cardinality: 1
Optional: true

period

Polling period in seconds. Tuples will be fetched every period seconds.

Properties

Type: float64
Cardinality: 1
Optional: true

updateParameter

URL query parameter to update based upon content in a successful request.

Properties

Type: rstring
Cardinality: 1
Optional: true

updateParameterFromContent

Update the query parameter set in updateParameter from the value of this XPath expression against the returned content.

Properties

Type: rstring
Cardinality: 1
Optional: true

url

URL to HTTP GET content from.

Properties

Type: rstring
Cardinality: 1
Optional: false

nFailedRequests - Counter

Number of HTTP requests that failed, did not return response 200.

Operator class library: Library Path: ../../impl/lib/com.teracloud.streams.inet.jar