Class EntityGetInsightsParameters


  • public final class EntityGetInsightsParameters
    extends Object
    The parameters required to execute insights operation on the given entity.
    • Constructor Detail

      • EntityGetInsightsParameters

        public EntityGetInsightsParameters()
    • Method Detail

      • startTime

        public OffsetDateTime startTime()
        Get the startTime property: The start timeline date, so the results returned are after this date.
        Returns:
        the startTime value.
      • withStartTime

        public EntityGetInsightsParameters withStartTime​(OffsetDateTime startTime)
        Set the startTime property: The start timeline date, so the results returned are after this date.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the EntityGetInsightsParameters object itself.
      • endTime

        public OffsetDateTime endTime()
        Get the endTime property: The end timeline date, so the results returned are before this date.
        Returns:
        the endTime value.
      • withEndTime

        public EntityGetInsightsParameters withEndTime​(OffsetDateTime endTime)
        Set the endTime property: The end timeline date, so the results returned are before this date.
        Parameters:
        endTime - the endTime value to set.
        Returns:
        the EntityGetInsightsParameters object itself.
      • addDefaultExtendedTimeRange

        public Boolean addDefaultExtendedTimeRange()
        Get the addDefaultExtendedTimeRange property: Indicates if query time range should be extended with default time range of the query. Default value is false.
        Returns:
        the addDefaultExtendedTimeRange value.
      • withAddDefaultExtendedTimeRange

        public EntityGetInsightsParameters withAddDefaultExtendedTimeRange​(Boolean addDefaultExtendedTimeRange)
        Set the addDefaultExtendedTimeRange property: Indicates if query time range should be extended with default time range of the query. Default value is false.
        Parameters:
        addDefaultExtendedTimeRange - the addDefaultExtendedTimeRange value to set.
        Returns:
        the EntityGetInsightsParameters object itself.
      • insightQueryIds

        public List<UUID> insightQueryIds()
        Get the insightQueryIds property: List of Insights Query Id. If empty, default value is all insights of this entity.
        Returns:
        the insightQueryIds value.
      • withInsightQueryIds

        public EntityGetInsightsParameters withInsightQueryIds​(List<UUID> insightQueryIds)
        Set the insightQueryIds property: List of Insights Query Id. If empty, default value is all insights of this entity.
        Parameters:
        insightQueryIds - the insightQueryIds value to set.
        Returns:
        the EntityGetInsightsParameters object itself.
      • validate

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