Class StreamConfiguration

  • All Implemented Interfaces:
    BatchCreationData, java.io.Serializable

    public class StreamConfiguration
    extends java.lang.Object
    implements BatchCreationData, java.io.Serializable
    Allows to define which items should be included into the stream.
    See Also:
    Serialized Form
    • Constructor Detail

      • StreamConfiguration

        protected StreamConfiguration​(java.lang.String streamId)
        Constructs the configuration
        Parameters:
        streamId - required stream identifier
        Throws:
        java.lang.NullPointerException - if streamId is null
    • Method Detail

      • withItemSelector

        public StreamConfiguration withItemSelector​(java.lang.String itemSelector)
        Allows to set selector for given stream. Think of a selector as a part of a where clause of the flexible search query.
        Parameters:
        itemSelector - selector to use by the stream
        Returns:
        the same configuration object
      • withItemTypeCode

        public StreamConfiguration withItemTypeCode​(java.lang.String itemTypeCode)
      • withDataHubColumns

        public StreamConfiguration withDataHubColumns​(java.lang.String dataHubColumns)
      • withImpExHeader

        public StreamConfiguration withImpExHeader​(java.lang.String impExHeader)
      • withParameters

        public StreamConfiguration withParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Allows to provide parameters for change detection query
        Parameters:
        parameters - parameters which will be passed to final query
        Returns:
        the same configuration object
        Throws:
        java.lang.NullPointerException - if parameters is null
      • withVersionValue

        public StreamConfiguration withVersionValue​(java.lang.String versionValue)
        Allows to specify a version value used to detect changes in the stream. This value will be used in select clause of the flexible search query.
        Parameters:
        versionValue -
        Returns:
        the same configuration object
      • withDataHubType

        public StreamConfiguration withDataHubType​(java.lang.String dataHubType)
      • getStreamId

        public java.lang.String getStreamId()
        Returns stream identifier
        Returns:
        stream identifier
      • getParameters

        public java.util.Map<java.lang.String,​java.lang.Object> getParameters()
        Returns parameters to use in the final query
        Returns:
        parameters
      • getItemSelector

        public java.lang.String getItemSelector()
        Returns item selector which will be used to select items
        Returns:
        item selector
      • getVersionValue

        public java.lang.String getVersionValue()
        Returns version value used by stream
        Returns:
        version value
      • getExcludedTypeCodes

        public java.util.Set<java.lang.String> getExcludedTypeCodes()
        Returns excluded type codes.
        Returns:
        set of excluded type codes
      • getItemTypeCode

        public java.lang.String getItemTypeCode()
      • getDataHubType

        public java.lang.String getDataHubType()
      • getImpExHeader

        public java.lang.String getImpExHeader()
      • getDataHubColumns

        public java.lang.String getDataHubColumns()
      • getSyncType

        public java.lang.String getSyncType()