restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/InvokeResult.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 org.eclipse.jdt.annotation.NonNull;
  11 import org.eclipse.jdt.annotation.Nullable;
  12 import org.opendaylight.restconf.api.FormattableBody;
  13
  14 /**
  15  * Result of a {@code POST} request resulting in an operation invocation, as defined in
  16  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.6">RFC8040 Operation Resource</a> and
  17  * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.4.2">RFC8040 Invoke Operation Mode</a>.
  18  *
  19  * @param output Non-empty operation output, or {@code null}
  20  */
  21 public record InvokeResult(@Nullable FormattableBody output) implements DataPostResult {
  22     /**
  23      * Empty instance. Prefer this to creating one with {@code output}.
  24      */
  25     public static final @NonNull InvokeResult EMPTY = new InvokeResult(null);
  26 }