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

   1 /*
   2  * Copyright (c) 2024 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 static java.util.Objects.requireNonNull;
  11
  12 import java.time.Instant;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.restconf.api.ApiPath;
  16
  17 /**
  18  * Result of a {@code POST} request in as defined in
  19  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4.1">RFC8040 Create Resource Mode</a>.
  20  *
  21  * @param createdPath API path of the newly-created resource
  22  * @param entityTag response {@code ETag} header, or {@code null} if not applicable
  23  * @param lastModified response {@code Last-Modified} header, or {@code null} if not applicable
  24  */
  25 public record CreateResourceResult(
  26         @NonNull ApiPath createdPath,
  27         @Nullable EntityTag entityTag,
  28         @Nullable Instant lastModified) implements DataPostResult, ConfigurationMetadata {
  29     public CreateResourceResult {
  30         requireNonNull(createdPath);
  31     }
  32
  33     public CreateResourceResult(final @NonNull ApiPath createdPath) {
  34         this(createdPath, null, null);
  35     }
  36 }