IBM Streams 4.3.0
View
This element resource provides access to information about a view that is
associated with an active job.
You can use the view to access job data. You can use
View actions to submit actions to a
view.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/views/{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. This property value is specified by the activateOption parameter in the view annotation. For more information, see View annotation.
- 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.
- bufferCapacitySeconds
- A number that indicates the size of the view buffer in seconds, as specified in the bufferTime parameter in the view annotation. If the bufferCapacityUnits property value is tuples, the bufferCapacitySeconds property is ignored.
- bufferCapacityTuples
- A number that indicates the size of the view buffer in tuples, as specified in the bufferSize parameter in the view annotation. If the bufferCapacityUnits property value is seconds, the bufferCapacityTuples property is ignored.
- 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, seconds, and unknown.
- description
- A string that describes the view.
- domain
- A string that identifies the URI that you can use to access information about the domain.
- filterAttribute
- A string that identifies the name of the attribute that is used
to filter the tuple data that is kept in the view. This property value
is specified by the filter parameter in the view
annotation.
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. This property value
is specified by the filter parameter in the view
annotation.
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. You can use the view collection resource to retrieve view identifiers. By default, when you retrieve a collection of view resources, they are sorted according to the id property value.
- instance
- A string that identifies the URI that you can use to access information about the instance.
- job
- A string that identifies the URI that you can use to access information about the job that contains the viewable data stream.
- logicalOperatorName
- A string that identifies the logical name of the operator that contains the output port on which the view is created.
- 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. This property value is specified by the sampleSize parameter in the view annotation.
- name
- A string that identifies the name of the view.
- ports
- A string that identifies the URI that you can use to access information about the output ports that are associated with the viewable data stream.
- resourceType
- A string that identifies the REST resource type, which is view.
- restid
- A string that represents the identifier that is used to uniquely identify the 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.
- started
- A boolean value that indicates whether the view is actively buffering data.
- viewItems
- A string that identifies the URI that you can use to access information about the data items that are buffered by the view.
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.