org.projectnessie.model.RefLogResponse 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) 2020 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.model;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.List;
import javax.validation.constraints.NotNull;
import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.immutables.value.Value;

@SuppressWarnings("all")
@Value.Immutable
@Schema(type = SchemaType.OBJECT, title = "RefLogResponse", deprecated = true, hidden = true)
@JsonSerialize(as = ImmutableRefLogResponse.class)
@JsonDeserialize(as = ImmutableRefLogResponse.class)
@Deprecated // Not supported since API v2
public interface RefLogResponse extends PaginatedResponse {

  @NotNull
  @jakarta.validation.constraints.NotNull
  List getLogEntries();

  @SuppressWarnings("all")
  @Value.Immutable
  @Schema(type = SchemaType.OBJECT, title = "RefLogResponseEntry", deprecated = true, hidden = true)
  @JsonSerialize(as = ImmutableRefLogResponseEntry.class)
  @JsonDeserialize(as = ImmutableRefLogResponseEntry.class)
  @Deprecated // Not supported since API v2
  interface RefLogResponseEntry {
    static ImmutableRefLogResponseEntry.Builder builder() {
      return ImmutableRefLogResponseEntry.builder();
    }

    // maps to getRefType() output.
    // Correspond to the enum names in RefLogEntry.RefType of persist.proto file.
    String BRANCH = "Branch";
    String TAG = "Tag";

    // maps to getOperation() output.
    // Correspond to the enum names in RefLogEntry.Operation of persist.proto file.
    String CREATE_REFERENCE = "CREATE_REFERENCE";
    String COMMIT = "COMMIT";
    String DELETE_REFERENCE = "DELETE_REFERENCE";
    String ASSIGN_REFERENCE = "ASSIGN_REFERENCE";
    String MERGE = "MERGE";
    String TRANSPLANT = "TRANSPLANT";

    /** Reflog id of the current entry. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getRefLogId();

    /** Reference on which current operation is executed. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getRefName();

    /** Reference type can be 'Branch' or 'Tag'. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getRefType();

    /** Output commit hash of the operation. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getCommitHash();

    /** Parent reflog id of the current entry. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getParentRefLogId();

    /** Time in microseconds since epoch. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    long getOperationTime();

    /** Operation String mapped to ENUM in {@code RefLogEntry.Operation} of 'persist.proto' file. */
    @NotNull
    @jakarta.validation.constraints.NotNull
    String getOperation();

    /**
     * Single hash in case of MERGE or ASSIGN. One or more hashes in case of TRANSPLANT. Empty list
     * for other operations.
     */
    @NotNull
    @jakarta.validation.constraints.NotNull
    List getSourceHashes();
  }
}