Class EntityTimelineParameters


  • public final class EntityTimelineParameters
    extends Object
    The parameters required to execute s timeline operation on the given entity.
    • Constructor Detail

      • EntityTimelineParameters

        public EntityTimelineParameters()
    • Method Detail

      • kinds

        public List<EntityTimelineKind> kinds()
        Get the kinds property: Array of timeline Item kinds.
        Returns:
        the kinds value.
      • withKinds

        public EntityTimelineParameters withKinds​(List<EntityTimelineKind> kinds)
        Set the kinds property: Array of timeline Item kinds.
        Parameters:
        kinds - the kinds value to set.
        Returns:
        the EntityTimelineParameters object itself.
      • 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 EntityTimelineParameters 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 EntityTimelineParameters 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 EntityTimelineParameters 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 EntityTimelineParameters object itself.
      • numberOfBucket

        public Integer numberOfBucket()
        Get the numberOfBucket property: The number of bucket for timeline queries aggregation.
        Returns:
        the numberOfBucket value.
      • withNumberOfBucket

        public EntityTimelineParameters withNumberOfBucket​(Integer numberOfBucket)
        Set the numberOfBucket property: The number of bucket for timeline queries aggregation.
        Parameters:
        numberOfBucket - the numberOfBucket value to set.
        Returns:
        the EntityTimelineParameters object itself.
      • validate

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