Caplin Systems - JsonSubscriptionParameters (StreamLink Java 7.1.19-993-0e59b8f API Documentation)

All Superinterfaces:

SubscriptionParameters
```
public interface JsonSubscriptionParameters
extends SubscriptionParameters
```
Defines the parameters used for Json subscriptions.

To create an instance of JsonSubscriptionParameters, use the {@link com.caplin.streamlink.StreamLink.createJsonSubscriptionParameters()} method.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`JsonSubscriptionParameters`	`addHeader(java.lang.String name, java.lang.String value)`	For REST operations this adds a HTTP header to be used by the resulting REST request.
`JsonSubscriptionParameters`	`setFilter(java.lang.String filter)`	Sets the filter that restricts the the information returned by the subscription.

- Method Detail
  - setFilter
```
JsonSubscriptionParameters setFilter(java.lang.String filter)
```
    Sets the filter that restricts the the information returned by the subscription. The filtering is performed by the Liberator, rather than the client, so that bandwidth and client side processing are reduced.
    
    For more details on the format of the filter string, please see https://goessner.net/articles/JsonPath/.
    
    Parameters:
    
    filter - The filter string.
    
    Returns:
    
    The updated JsonSubscriptionParameters object to permit a fluent style.
  - addHeader
```
JsonSubscriptionParameters addHeader(java.lang.String name,
                                     java.lang.String value)
```
    For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are added will be the order in which they are applied to the REST operation.
    
    Parameters:
    
    name - the name of the HTTP header
    
    value - the value of the header
    
    Returns:
    
    The updated JsonSubscriptionParameters object to permit a fluent style.