IBM Streams 4.3.0
Configured view
Note: This
REST API resource is deprecated and might become obsolete. Use the view element
resource instead.
This element resource provides
access to configuration information for a view.
The information
includes details about the associated application, the set of attributes
to collect from the data stream, and the buffer settings. When started,
a view buffers stream data for a job. This data can be used in custom
applications or third-party charting tools.Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/configuredviews/{restid}Properties
This element resource has the
following properties:
- activateOption
- A string that indicates when the view starts buffering data. For example, if the buffering starts when data is first received by the view, the property has a value of automatic. If the buffering starts when data is first requested from the view, the property has a value of firstAccess.
- activeViews
- A string that identifies the URI that you can use to access information about the active views that are associated with this configured view.
- adlFile
- A string that identifies the absolute path for an application description language file (ADL file). The ADL file is for the application that is associated with the view.
- applicationName
- A string that identifies the name of the application that is associated with the view.
- attributes
- An array that provides the following information for each attribute
in the view:
- name
- A string that identifies the name of the attribute.
- type
- A string that identifies the SPL data type for the attribute.
- bufferCapacity
- A number that indicates the amount of historical data to buffer in the view. The unit of measurement for the buffer capacity is specified in the bufferCapacityUnits property.
- bufferCapacityUnits
- A string that indicates whether the buffer capacity for the view is determined by the number of tuples in the buffer or by the number of seconds that data is in the buffer. Possible values for this property include tuples and seconds.
- description
- A string that describes the view.
- filterAttribute
- A string that identifies the name of the attribute that is used to filter the tuple data that is kept in the view. If the filterData property has a value of false, the filterAttribute property is ignored.
- filterData
- A boolean value that indicates whether there is a filter on the tuple data that is kept in the view. By default, views keep attribute data for all tuples.
- filterExpression
- A string that identifies the regular expression that is used to filter the tuple data that is kept in the view. If the filterData property has a value of false, the filterExpression property is ignored.
- id
- A string that represents the system-generated identifier that is used to uniquely identify the view. The identifier is generated when the view is created. You can retrieve the identifier from the configured view collection resource.
- maximumTupleRate
- A number that indicates the maximum rate at which the view collects tuple data. The unit of measurement for the number is tuples per second.
- name
- A string that identifies the name of the view. By default, when you retrieve a collection of configured view resources, they are sorted according to this property value.
- operatorName
- A string that identifies the name of the operator that is associated with the viewable data stream.
- portIndex
- A number that represents the index of the output port within the operator that is associated with the viewable data stream.
- resourceType
- A string that identifies the REST resource type, which is configuredView.
- restid
- A string that represents the identifier that is used to uniquely identify the configured view 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.
- streamName
- A string that identifies the name of the viewable data stream.
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.