restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/DataPutResult.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.server.api;
   9
  10 import java.time.Instant;
  11 import org.eclipse.jdt.annotation.Nullable;
  12
  13 /**
  14  * Result of a {@code PUT} request as defined in
  15  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>. The definition makes it
  16  * clear that the logical operation is {@code create-or-replace}.
  17  *
  18  * @param created {@code true} if the resource was created, {@code false} if it was replaced
  19  * @param entityTag response {@code ETag} header, or {@code null} if not applicable
  20  * @param lastModified response {@code Last-Modified} header, or {@code null} if not applicable
  21  */
  22 public record DataPutResult(
  23         boolean created,
  24         @Nullable EntityTag entityTag,
  25         @Nullable Instant lastModified) implements ConfigurationMetadata {
  26     public DataPutResult(final boolean created) {
  27         this(created, null, null);
  28     }
  29 }