Package org.gitlab4j.api.models

Class EpicFilter

  • All Implemented Interfaces:
    java.io.Serializable
    public class EpicFilter
extends java.lang.Object
implements java.io.Serializable
    This class is used to filter Groups when getting lists of epics.
    See Also:
    Serialized Form

    • Constructor Detail

      • EpicFilter

        public EpicFilter()

    • Method Detail

      • withAuthorId

        public EpicFilter withAuthorId​(java.lang.Long authorId)
        Add 'author id' filter.
        Parameters:
        authorId - the author id filter
        Returns:
        the reference to this EpicFilter instance

      • withAuthorUsername

        public EpicFilter withAuthorUsername​(java.lang.String authorUsername)
        Add 'author username' filter.
        Parameters:
        authorUsername - the 'author username' filter
        Returns:
        the reference to this EpicFilter instance

      • withLabels

        public EpicFilter withLabels​(java.lang.String labels)
        Add 'labels' filter.
        Parameters:
        labels - the labels filter
        Returns:
        the reference to this EpicFilter instance

      • withOrderBy

        public EpicFilter withOrderBy​(Constants.EpicOrderBy orderBy)
        Add 'order by' filter.
        Parameters:
        orderBy - the 'order by' filter
        Returns:
        the reference to this GroupFilter instance

      • withSortOrder

        public EpicFilter withSortOrder​(Constants.SortOrder sort)
        Add 'sort' filter.
        Parameters:
        sort - sort direction, ASC or DESC
        Returns:
        the reference to this GroupFilter instance

      • withSearch

        public EpicFilter withSearch​(java.lang.String search)
        Add 'search' filter.
        Parameters:
        search - the 'search' filter
        Returns:
        the reference to this EpicFilter instance

      • withState

        public EpicFilter withState​(AbstractEpic.EpicState state)
        Add 'state' filter.
        Parameters:
        state - the 'state' filter
        Returns:
        the reference to this EpicFilter instance

      • withCreatedAfter

        public EpicFilter withCreatedAfter​(java.util.Date createdAfter)
        Add 'created after' filter.
        Parameters:
        createdAfter - the 'created after' filter
        Returns:
        the reference to this EpicFilter instance

      • withUpdatedAfter

        public EpicFilter withUpdatedAfter​(java.util.Date updatedAfter)
        Add 'updated after' filter.
        Parameters:
        updatedAfter - the 'updated after' filter
        Returns:
        the reference to this EpicFilter instance

      • withUpdatedBefore

        public EpicFilter withUpdatedBefore​(java.util.Date updatedBefore)
        Add 'updated before' filter.
        Parameters:
        updatedBefore - the 'updated before' filter
        Returns:
        the reference to this EpicFilter instance

      • withIncludeAncestorGroups

        public EpicFilter withIncludeAncestorGroups​(java.lang.Boolean includeAncestorGroups)
        Add 'include ancestor groups' filter.
        Parameters:
        includeAncestorGroups - the 'include ancestor groups' filter
        Returns:
        the reference to this EpicFilter instance

      • withIncludeDescendantGroups

        public EpicFilter withIncludeDescendantGroups​(java.lang.Boolean includeDescendantGroups)
        Add 'include descendant groups' filter.
        Parameters:
        includeDescendantGroups - the 'include descendant groups' filter
        Returns:
        the reference to this EpicFilter instance

      • withMyReactionEmoji

        public EpicFilter withMyReactionEmoji​(java.lang.String myReactionEmoji)
        Add 'my reaction emoji' filter.
        Parameters:
        myReactionEmoji - the 'my reaction emoji' filter
        Returns:
        the reference to this EpicFilter instance

      • withNot

        public EpicFilter withNot​(java.util.Map<EpicFilter.EpicField,​java.lang.Object> not)
        Add 'not' filter.
        Parameters:
        not - the 'not' filter
        Returns:
        the reference to this EpicFilter instance

      • withoutAuthorId

        public EpicFilter withoutAuthorId​(java.lang.Long authorId)
        Add author_id to the 'not' filter entry.
        Parameters:
        authorId - the id of the author to add to the filter
        Returns:
        the reference to this EpicFilter instance

      • withoutAuthorUsername

        public EpicFilter withoutAuthorUsername​(java.lang.String authorUsername)
        Add author_username to the 'not' filter entry.
        Parameters:
        authorUsername - the username of the author to add to the filter
        Returns:
        the reference to this EpicFilter instance

      • withoutLabels

        public EpicFilter withoutLabels​(java.lang.String... labels)
        Add labels to the 'not' filter entry.
        Parameters:
        labels - the labels to add to the filter
        Returns:
        the reference to this EpicFilter instance

      • withNot

        public EpicFilter withNot​(EpicFilter.EpicField field,
                          java.lang.Object value)
        Add 'not' filter entry.
        Parameters:
        field - the field to be added to the 'not' value
        value - the value for the entry
        Returns:
        the reference to this EpicFilter instance

      • getQueryParams

        public GitLabForm getQueryParams()
        Get the query params specified by this filter.
        Returns:
        a GitLabApiForm instance holding the query parameters for this GroupFilter instance