Package org.projectnessie.client.builder

Class BaseGetEntriesBuilder<PARAMS>

    • Field Detail

      • maxRecords

        protected java.lang.Integer maxRecords

      • keys

        protected final java.util.List<org.projectnessie.model.ContentKey> keys

      • minKey

        protected org.projectnessie.model.ContentKey minKey

      • maxKey

        protected org.projectnessie.model.ContentKey maxKey

      • prefixKey

        protected org.projectnessie.model.ContentKey prefixKey

      • filter

        protected java.lang.String filter

      • namespaceDepth

        protected java.lang.Integer namespaceDepth

      • withContent

        protected boolean withContent

      • refName

        protected java.lang.String refName

      • hashOnRef

        protected java.lang.String hashOnRef

    • Constructor Detail

      • BaseGetEntriesBuilder

        protected BaseGetEntriesBuilder​(java.util.function.BiFunction<PARAMS,​java.lang.String,​PARAMS> paramsForPage)

    • Method Detail

      • maxRecords

        public GetEntriesBuilder maxRecords​(int maxRecords)
        Description copied from interface: PagingBuilder
        Sets the maximum number of records to be returned in a single response object from the PagingBuilder.get() method.

        This setter reflects the OpenAPI parameter maxRecords in a paged request.

        Specified by:
        maxRecords in interface PagingBuilder<GetEntriesBuilder,​org.projectnessie.model.EntriesResponse,​org.projectnessie.model.EntriesResponse.Entry>

      • params

        protected abstract PARAMS params()

      • get

        protected abstract org.projectnessie.model.EntriesResponse get​(PARAMS p)
                                                        throws org.projectnessie.error.NessieNotFoundException
        Throws:
        org.projectnessie.error.NessieNotFoundException

      • get

        public org.projectnessie.model.EntriesResponse get()
                                            throws org.projectnessie.error.NessieNotFoundException
        Description copied from interface: PagingBuilder
        Advanced usage, for manual paging: fetches a response chunk (might be one page or complete response depending on use case and parameters), but callers must implement paging on their own, if necessary. If in doubt, use PagingBuilder.stream() instead.
        Specified by:
        get in interface GetEntriesBuilder
        Specified by:
        get in interface PagingBuilder<GetEntriesBuilder,​org.projectnessie.model.EntriesResponse,​org.projectnessie.model.EntriesResponse.Entry>
        Throws:
        org.projectnessie.error.NessieNotFoundException

      • stream

        public java.util.stream.Stream<org.projectnessie.model.EntriesResponse.Entry> stream()
                                                                              throws org.projectnessie.error.NessieNotFoundException
        Description copied from interface: PagingBuilder
        Retrieve entries/results as a Java Stream, uses automatic paging.
        Specified by:
        stream in interface PagingBuilder<GetEntriesBuilder,​org.projectnessie.model.EntriesResponse,​org.projectnessie.model.EntriesResponse.Entry>
        Throws:
        org.projectnessie.error.NessieNotFoundException

      • hashOnRef

        public R hashOnRef​(java.lang.String hashOnRef)
        Description copied from interface: OnReferenceBuilder
        Optional commit ID with an optional sequence of relative lookups. Relative lookups can be by-timestamp, by-n-th-predecessor or by-n-th-parent.

        Relative lookups are only supported for REST API v2 against servers announcing Nessie specification 2.1.0 for most functionalities.

        • Lookup by timestamp starts with * followed by the numeric value of the timestamp in milliseconds since epoch.
        • Lookup by n-th predecessor starts with ~ followed by the value for the n-th commit in the commit log.
        • Lookup by n-th parent starts with ^ followed by either 1, referencing the direct parent, or 2, referencing the merge parent.

        Valid values are:

        • ~10 -> the 10th parent from the HEAD
        • 11223344~10 -> the 10th parent of the commit 11223344
        • 11223344^2 -> the merge parent of the commit 11223344
        • 11223344~10^2 -> the merge parent of the 10th parent of the commit 11223344
        • 11223344~10^1 -> the direct parent of the 10th parent of the commit 11223344 - functionally equal to 11223344~11
        • 11223344*10000000000 -> the commit in the commit log starting at 11223344 with a commit-created timestamp of 10000000000 or less.
        • *10000000000 -> the commit in the commit log starting at HEAD with a commit-created timestamp of 10000000000 or less.
        Specified by:
        hashOnRef in interface OnReferenceBuilder<R extends OnReferenceBuilder<R>>