Class SplunkConfiguration


  • @UriParams
    public class SplunkConfiguration
    extends Object
    • Constructor Detail

      • SplunkConfiguration

        public SplunkConfiguration()
    • Method Detail

      • getName

        public String getName()
      • setName

        public void setName​(String name)
      • getInitEarliestTime

        public String getInitEarliestTime()
      • setInitEarliestTime

        public void setInitEarliestTime​(String initEarliestTime)
        Initial start offset of the first search
      • getCount

        public int getCount()
      • setCount

        public void setCount​(int count)
        A number that indicates the maximum number of entities to return.
      • getSearch

        public String getSearch()
      • setSearch

        public void setSearch​(String search)
        The Splunk query to run
      • getEarliestTime

        public String getEarliestTime()
      • setEarliestTime

        public void setEarliestTime​(String earliestTime)
        Earliest time of the search time window.
      • getLatestTime

        public String getLatestTime()
      • setLatestTime

        public void setLatestTime​(String latestTime)
        Latest time of the search time window.
      • getTcpReceiverPort

        public int getTcpReceiverPort()
      • setTcpReceiverPort

        public void setTcpReceiverPort​(int tcpReceiverPort)
        Splunk tcp receiver port
      • getTcpReceiverLocalPort

        public Integer getTcpReceiverLocalPort()
      • setTcpReceiverLocalPort

        public void setTcpReceiverLocalPort​(Integer tcpReceiverLocalPort)
        Splunk tcp receiver port defined locally on splunk server. (For example if splunk port 9997 is mapped to 12345, tcpReceiverLocalPort has to be 9997)
      • isRaw

        public boolean isRaw()
      • setRaw

        public void setRaw​(boolean raw)
        Should the payload be inserted raw
      • getSourceType

        public String getSourceType()
      • setSourceType

        public void setSourceType​(String sourceType)
        Splunk sourcetype argument
      • getSource

        public String getSource()
      • setSource

        public void setSource​(String source)
        Splunk source argument
      • getEventHost

        public String getEventHost()
      • setEventHost

        public void setEventHost​(String eventHost)
        Override the default Splunk event host field
      • setIndex

        public void setIndex​(String index)
        Splunk index to write to
      • getIndex

        public String getIndex()
      • getHost

        public String getHost()
      • setHost

        public void setHost​(String host)
        Splunk host.
      • getPort

        public int getPort()
      • setPort

        public void setPort​(int port)
        Splunk port
      • getSslProtocol

        public com.splunk.SSLSecurityProtocol getSslProtocol()
      • setSslProtocol

        public void setSslProtocol​(com.splunk.SSLSecurityProtocol sslProtocol)
        Set the ssl protocol to use
        Parameters:
        sslProtocol -
      • getScheme

        public String getScheme()
      • setScheme

        public void setScheme​(String scheme)
        Splunk scheme
      • getApp

        public String getApp()
      • setApp

        public void setApp​(String app)
        Splunk app
      • getOwner

        public String getOwner()
      • setOwner

        public void setOwner​(String owner)
        Splunk owner
      • getUsername

        public String getUsername()
      • setUsername

        public void setUsername​(String username)
        Username for Splunk
      • getPassword

        public String getPassword()
      • setPassword

        public void setPassword​(String password)
        Password for Splunk
      • getToken

        public String getToken()
      • setToken

        public void setToken​(String token)
        User's token for Splunk. This takes precedence over password when both are set
      • isStreaming

        public boolean isStreaming()
      • setStreaming

        public void setStreaming​(boolean streaming)
        Sets streaming mode.

        Streaming mode sends exchanges as they are received, rather than in a batch.

      • getConnectionTimeout

        public int getConnectionTimeout()
      • setConnectionTimeout

        public void setConnectionTimeout​(int timeout)
        Timeout in MS when connecting to Splunk server
      • isUseSunHttpsHandler

        public boolean isUseSunHttpsHandler()
      • setUseSunHttpsHandler

        public void setUseSunHttpsHandler​(boolean useSunHttpsHandler)
        Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling.
      • getSavedSearch

        public String getSavedSearch()
      • setSavedSearch

        public void setSavedSearch​(String savedSearch)
        The name of the query saved in Splunk to run
      • setConnectionFactory

        public void setConnectionFactory​(SplunkConnectionFactory connectionFactory)
        Splunk connection factory.