Class CodelessConnectorPollingPagingProperties


  • public final class CodelessConnectorPollingPagingProperties
    extends Object
    Describe the properties needed to make a pagination call.
    • Constructor Detail

      • CodelessConnectorPollingPagingProperties

        public CodelessConnectorPollingPagingProperties()
    • Method Detail

      • pagingType

        public String pagingType()
        Get the pagingType property: Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'.
        Returns:
        the pagingType value.
      • withPagingType

        public CodelessConnectorPollingPagingProperties withPagingType​(String pagingType)
        Set the pagingType property: Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'.
        Parameters:
        pagingType - the pagingType value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • nextPageParaName

        public String nextPageParaName()
        Get the nextPageParaName property: Defines the name of a next page attribute.
        Returns:
        the nextPageParaName value.
      • withNextPageParaName

        public CodelessConnectorPollingPagingProperties withNextPageParaName​(String nextPageParaName)
        Set the nextPageParaName property: Defines the name of a next page attribute.
        Parameters:
        nextPageParaName - the nextPageParaName value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • nextPageTokenJsonPath

        public String nextPageTokenJsonPath()
        Get the nextPageTokenJsonPath property: Defines the path to a next page token JSON.
        Returns:
        the nextPageTokenJsonPath value.
      • withNextPageTokenJsonPath

        public CodelessConnectorPollingPagingProperties withNextPageTokenJsonPath​(String nextPageTokenJsonPath)
        Set the nextPageTokenJsonPath property: Defines the path to a next page token JSON.
        Parameters:
        nextPageTokenJsonPath - the nextPageTokenJsonPath value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • pageCountAttributePath

        public String pageCountAttributePath()
        Get the pageCountAttributePath property: Defines the path to a page count attribute.
        Returns:
        the pageCountAttributePath value.
      • withPageCountAttributePath

        public CodelessConnectorPollingPagingProperties withPageCountAttributePath​(String pageCountAttributePath)
        Set the pageCountAttributePath property: Defines the path to a page count attribute.
        Parameters:
        pageCountAttributePath - the pageCountAttributePath value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • pageTotalCountAttributePath

        public String pageTotalCountAttributePath()
        Get the pageTotalCountAttributePath property: Defines the path to a page total count attribute.
        Returns:
        the pageTotalCountAttributePath value.
      • withPageTotalCountAttributePath

        public CodelessConnectorPollingPagingProperties withPageTotalCountAttributePath​(String pageTotalCountAttributePath)
        Set the pageTotalCountAttributePath property: Defines the path to a page total count attribute.
        Parameters:
        pageTotalCountAttributePath - the pageTotalCountAttributePath value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • pageTimestampAttributePath

        public String pageTimestampAttributePath()
        Get the pageTimestampAttributePath property: Defines the path to a paging time stamp attribute.
        Returns:
        the pageTimestampAttributePath value.
      • withPageTimestampAttributePath

        public CodelessConnectorPollingPagingProperties withPageTimestampAttributePath​(String pageTimestampAttributePath)
        Set the pageTimestampAttributePath property: Defines the path to a paging time stamp attribute.
        Parameters:
        pageTimestampAttributePath - the pageTimestampAttributePath value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • searchTheLatestTimestampFromEventsList

        public String searchTheLatestTimestampFromEventsList()
        Get the searchTheLatestTimestampFromEventsList property: Determines whether to search for the latest time stamp in the events list.
        Returns:
        the searchTheLatestTimestampFromEventsList value.
      • withSearchTheLatestTimestampFromEventsList

        public CodelessConnectorPollingPagingProperties withSearchTheLatestTimestampFromEventsList​(String searchTheLatestTimestampFromEventsList)
        Set the searchTheLatestTimestampFromEventsList property: Determines whether to search for the latest time stamp in the events list.
        Parameters:
        searchTheLatestTimestampFromEventsList - the searchTheLatestTimestampFromEventsList value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • pageSizeParaName

        public String pageSizeParaName()
        Get the pageSizeParaName property: Defines the name of the page size parameter.
        Returns:
        the pageSizeParaName value.
      • withPageSizeParaName

        public CodelessConnectorPollingPagingProperties withPageSizeParaName​(String pageSizeParaName)
        Set the pageSizeParaName property: Defines the name of the page size parameter.
        Parameters:
        pageSizeParaName - the pageSizeParaName value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • pageSize

        public Integer pageSize()
        Get the pageSize property: Defines the paging size.
        Returns:
        the pageSize value.
      • withPageSize

        public CodelessConnectorPollingPagingProperties withPageSize​(Integer pageSize)
        Set the pageSize property: Defines the paging size.
        Parameters:
        pageSize - the pageSize value to set.
        Returns:
        the CodelessConnectorPollingPagingProperties object itself.
      • validate

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