Package com.merge.api.resources.hris.groups.requests

Class GroupsListRequest

  • public final class GroupsListRequest
extends java.lang.Object

    • Method Detail

      • getCreatedAfter

        public java.util.Optional<java.time.OffsetDateTime> getCreatedAfter()
        Returns:
        If provided, will only return objects created after this datetime.

      • getCreatedBefore

        public java.util.Optional<java.time.OffsetDateTime> getCreatedBefore()
        Returns:
        If provided, will only return objects created before this datetime.

      • getCursor

        public java.util.Optional<java.lang.String> getCursor()
        Returns:
        The pagination cursor value.

      • getIncludeDeletedData

        public java.util.Optional<java.lang.Boolean> getIncludeDeletedData()
        Returns:
        Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

      • getIncludeRemoteData

        public java.util.Optional<java.lang.Boolean> getIncludeRemoteData()
        Returns:
        Whether to include the original data Merge fetched from the third-party to produce these models.

      • getIncludeShellData

        public java.util.Optional<java.lang.Boolean> getIncludeShellData()
        Returns:
        Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

      • getIsCommonlyUsedAsTeam

        public java.util.Optional<java.lang.String> getIsCommonlyUsedAsTeam()
        Returns:
        If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.

      • getModifiedAfter

        public java.util.Optional<java.time.OffsetDateTime> getModifiedAfter()
        Returns:
        If provided, only objects synced by Merge after this date time will be returned.

      • getModifiedBefore

        public java.util.Optional<java.time.OffsetDateTime> getModifiedBefore()
        Returns:
        If provided, only objects synced by Merge before this date time will be returned.

      • getNames

        public java.util.Optional<java.lang.String> getNames()
        Returns:
        If provided, will only return groups with these names. Multiple values can be separated by commas.

      • getPageSize

        public java.util.Optional<java.lang.Integer> getPageSize()
        Returns:
        Number of results to return per page.

      • getRemoteFields

        public java.util.Optional<java.lang.String> getRemoteFields()
        Returns:
        Deprecated. Use show_enum_origins.

      • getRemoteId

        public java.util.Optional<java.lang.String> getRemoteId()
        Returns:
        The API provider's ID for the given object.

      • getShowEnumOrigins

        public java.util.Optional<java.lang.String> getShowEnumOrigins()
        Returns:
        A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

      • getTypes

        public java.util.Optional<java.lang.String> getTypes()
        Returns:
        If provided, will only return groups of these types. Multiple values can be separated by commas.

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object