Class BookmarkExpandParameters


  • public final class BookmarkExpandParameters
    extends Object
    The parameters required to execute an expand operation on the given bookmark.
    • Constructor Detail

      • BookmarkExpandParameters

        public BookmarkExpandParameters()
    • Method Detail

      • endTime

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

        public BookmarkExpandParameters withEndTime​(OffsetDateTime endTime)
        Set the endTime property: The end date filter, so the only expansion results returned are before this date.
        Parameters:
        endTime - the endTime value to set.
        Returns:
        the BookmarkExpandParameters object itself.
      • expansionId

        public UUID expansionId()
        Get the expansionId property: The Id of the expansion to perform.
        Returns:
        the expansionId value.
      • withExpansionId

        public BookmarkExpandParameters withExpansionId​(UUID expansionId)
        Set the expansionId property: The Id of the expansion to perform.
        Parameters:
        expansionId - the expansionId value to set.
        Returns:
        the BookmarkExpandParameters object itself.
      • startTime

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

        public BookmarkExpandParameters withStartTime​(OffsetDateTime startTime)
        Set the startTime property: The start date filter, so the only expansion results returned are after this date.
        Parameters:
        startTime - the startTime value to set.
        Returns:
        the BookmarkExpandParameters object itself.
      • validate

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