Class CodelessConnectorPollingRequestProperties


  • public final class CodelessConnectorPollingRequestProperties
    extends Object
    Describe the request properties needed to successfully pull from the server.
    • Constructor Detail

      • CodelessConnectorPollingRequestProperties

        public CodelessConnectorPollingRequestProperties()
    • Method Detail

      • apiEndpoint

        public String apiEndpoint()
        Get the apiEndpoint property: Describe the endpoint we should pull the data from.
        Returns:
        the apiEndpoint value.
      • withApiEndpoint

        public CodelessConnectorPollingRequestProperties withApiEndpoint​(String apiEndpoint)
        Set the apiEndpoint property: Describe the endpoint we should pull the data from.
        Parameters:
        apiEndpoint - the apiEndpoint value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • rateLimitQps

        public Integer rateLimitQps()
        Get the rateLimitQps property: Defines the rate limit QPS.
        Returns:
        the rateLimitQps value.
      • withRateLimitQps

        public CodelessConnectorPollingRequestProperties withRateLimitQps​(Integer rateLimitQps)
        Set the rateLimitQps property: Defines the rate limit QPS.
        Parameters:
        rateLimitQps - the rateLimitQps value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • queryWindowInMin

        public int queryWindowInMin()
        Get the queryWindowInMin property: The window interval we will use the pull the data.
        Returns:
        the queryWindowInMin value.
      • withQueryWindowInMin

        public CodelessConnectorPollingRequestProperties withQueryWindowInMin​(int queryWindowInMin)
        Set the queryWindowInMin property: The window interval we will use the pull the data.
        Parameters:
        queryWindowInMin - the queryWindowInMin value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • httpMethod

        public String httpMethod()
        Get the httpMethod property: The http method type we will use in the poll request, GET or POST.
        Returns:
        the httpMethod value.
      • withHttpMethod

        public CodelessConnectorPollingRequestProperties withHttpMethod​(String httpMethod)
        Set the httpMethod property: The http method type we will use in the poll request, GET or POST.
        Parameters:
        httpMethod - the httpMethod value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • queryTimeFormat

        public String queryTimeFormat()
        Get the queryTimeFormat property: The time format will be used the query events in a specific window.
        Returns:
        the queryTimeFormat value.
      • withQueryTimeFormat

        public CodelessConnectorPollingRequestProperties withQueryTimeFormat​(String queryTimeFormat)
        Set the queryTimeFormat property: The time format will be used the query events in a specific window.
        Parameters:
        queryTimeFormat - the queryTimeFormat value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • retryCount

        public Integer retryCount()
        Get the retryCount property: Describe the amount of time we should try and poll the data in case of failure.
        Returns:
        the retryCount value.
      • withRetryCount

        public CodelessConnectorPollingRequestProperties withRetryCount​(Integer retryCount)
        Set the retryCount property: Describe the amount of time we should try and poll the data in case of failure.
        Parameters:
        retryCount - the retryCount value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • timeoutInSeconds

        public Integer timeoutInSeconds()
        Get the timeoutInSeconds property: The number of seconds we will consider as a request timeout.
        Returns:
        the timeoutInSeconds value.
      • withTimeoutInSeconds

        public CodelessConnectorPollingRequestProperties withTimeoutInSeconds​(Integer timeoutInSeconds)
        Set the timeoutInSeconds property: The number of seconds we will consider as a request timeout.
        Parameters:
        timeoutInSeconds - the timeoutInSeconds value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • headers

        public Object headers()
        Get the headers property: Describe the headers sent in the poll request.
        Returns:
        the headers value.
      • withHeaders

        public CodelessConnectorPollingRequestProperties withHeaders​(Object headers)
        Set the headers property: Describe the headers sent in the poll request.
        Parameters:
        headers - the headers value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • queryParameters

        public Object queryParameters()
        Get the queryParameters property: Describe the query parameters sent in the poll request.
        Returns:
        the queryParameters value.
      • withQueryParameters

        public CodelessConnectorPollingRequestProperties withQueryParameters​(Object queryParameters)
        Set the queryParameters property: Describe the query parameters sent in the poll request.
        Parameters:
        queryParameters - the queryParameters value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • queryParametersTemplate

        public String queryParametersTemplate()
        Get the queryParametersTemplate property: For advanced scenarios for example user name/password embedded in nested JSON payload.
        Returns:
        the queryParametersTemplate value.
      • withQueryParametersTemplate

        public CodelessConnectorPollingRequestProperties withQueryParametersTemplate​(String queryParametersTemplate)
        Set the queryParametersTemplate property: For advanced scenarios for example user name/password embedded in nested JSON payload.
        Parameters:
        queryParametersTemplate - the queryParametersTemplate value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • startTimeAttributeName

        public String startTimeAttributeName()
        Get the startTimeAttributeName property: This will be used the query events from a start of the time window.
        Returns:
        the startTimeAttributeName value.
      • withStartTimeAttributeName

        public CodelessConnectorPollingRequestProperties withStartTimeAttributeName​(String startTimeAttributeName)
        Set the startTimeAttributeName property: This will be used the query events from a start of the time window.
        Parameters:
        startTimeAttributeName - the startTimeAttributeName value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • endTimeAttributeName

        public String endTimeAttributeName()
        Get the endTimeAttributeName property: This will be used the query events from the end of the time window.
        Returns:
        the endTimeAttributeName value.
      • withEndTimeAttributeName

        public CodelessConnectorPollingRequestProperties withEndTimeAttributeName​(String endTimeAttributeName)
        Set the endTimeAttributeName property: This will be used the query events from the end of the time window.
        Parameters:
        endTimeAttributeName - the endTimeAttributeName value to set.
        Returns:
        the CodelessConnectorPollingRequestProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.