org.projectnessie.api.v1.RefLogApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nessie-model-quarkus Show documentation

nessie-model-jakarta is effectively the same as nessie-model, but it is _not_ a multi-release jar and retains the jakarta annotations in the canonical classes. Please note that this artifact will go away, once Nessie no longer support Java 8 for clients. Therefore, do _not_ refer to this artifact - it is only meant for consumption by Nessie-Quarkus.

The newest version!

/*
 * Copyright (C) 2022 Dremio
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.projectnessie.api.v1;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import org.projectnessie.api.v1.params.RefLogParams;
import org.projectnessie.error.NessieNotFoundException;
import org.projectnessie.model.RefLogResponse;

@Deprecated
public interface RefLogApi {

  // Note: When substantial changes in Nessie API (this and related interfaces) are made
  // the API version number reported by NessieConfiguration.getMaxSupportedApiVersion()
  // should be increased as well.

  /**
   * Retrieve the reflog, potentially truncated by the backend.
   *
   * The Nessie reflog in this form is deprecated, likely for removal.
   *
   * 
Retrieves up to {@code maxRecords} refLog-entries starting at the HEAD of current-reflog.
   * The backend may respect the given {@code max} records hint, but return less or more
   * entries. Backends may also cap the returned entries at a hard-coded limit, the default REST
   * server implementation has such a hard-coded limit.
   *
   * 
Invoking {@code getRefLog()} does not guarantee to return all refLog entries
   * because the result can be truncated by the backend.
   *
   * 
To implement paging, check {@link RefLogResponse#isHasMore() RefLogResponse.isHasMore()}
   * and, if {@code true}, pass the value of {@link RefLogResponse#getToken()
   * RefLogResponse.getToken()} in the next invocation of {@code getRefLog()} as the {@code
   * pageToken} parameter.
   *
   * See {@code org.projectnessie.client.StreamingUtil} in {@code nessie-client}.
   *
   * @return {@link RefLogResponse}
   */
  @Deprecated
  RefLogResponse getRefLog(
      @Valid @jakarta.validation.Valid @NotNull @jakarta.validation.constraints.NotNull
          RefLogParams params)
      throws NessieNotFoundException;
}