com.ibm.streamsx.rest (Java Application API for IBM Streams)
Date: 2020-08-07

# Package com.ibm.streamsx.rest

Java bindings for the REST APIs of IBM Streams and Streaming Analytics service.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Result<T,R> | Represents a result from a REST request.
  StreamingAnalyticsService | Access to a Streaming Analytics service on IBM Cloud.

- Class Summary
  Class | Description
  --- | ---
  ActiveVersion | Basic class to hold the ActiveVersion JSON structure
  ApplicationBundle | An object describing an IBM Streams Domain
  Domain | An object describing an IBM Streams Domain
  Element | IBM Streams element.
  InputPort | An Input Port of the IBM Streams Operator
  Instance | An object describing an IBM Streams Instance
  Job | An object describing an IBM Streams Job submitted within a specified instance
  JobSubmitParameters | Holds Submisson Paramters for a Job
  Metric | An object describing an IBM Streams Metric
  Operator | An object describing an IBM Streams Operator
  OutputPort | An Output Port of the IBM Streams Operator
  PEInputPort | An Input Port of the IBM Streams Processing Element
  PEOutputPort | A Output Port of the IBM Streams Processing Element
  ProcessingElement | An object describing an IBM Streams Processing Element
  Resource | Domain resource information.
  ResourceAllocation | Access to information about a resource that is allocated to a Streams instance.
  RESTErrorMessage | An object describing an IBM Streams REST api Error Message
  StreamsConnection | Connection to IBM Streams.

- Exception Summary
  Exception | Description
  --- | ---
  RESTException | Exception for REST api wrappers

## Package com.ibm.streamsx.rest Description

Java bindings for the REST APIs of IBM Streams and Streaming Analytics service.

This API is used to access the REST API in the IBM Streams product and the IBM Streaming Analytics service through a java class.

For the IBM Streams product, a `StreamsConnection` object is created to access the rest of the resource types in the domain.

For the IBM Streaming Analytics service, a `StreamingAnalyticsService` object is created to access the rest of the resource types in the service.