org.projectnessie.api.v1.DiffApi 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.DiffParams;
import org.projectnessie.error.NessieNotFoundException;
import org.projectnessie.model.DiffResponse;

public interface DiffApi {

  /**
   * Returns a list of diff values that show the difference between two given references.
   *
   * @param params The {@link DiffParams} that includes the parameters for this API call.
   * @return A list of diff values that show the difference between two given references.
   */
  DiffResponse getDiff(
      @Valid @jakarta.validation.Valid @NotNull @jakarta.validation.constraints.NotNull
          DiffParams params)
      throws NessieNotFoundException;
}