Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324

Interface GetConstrainedPathInput

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<GetConstrainedPathInput>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.RpcInput
@Generated("mdsal-binding-generator") public interface GetConstrainedPathInput extends org.opendaylight.yangtools.binding.RpcInput, org.opendaylight.yangtools.binding.Augmentable<GetConstrainedPathInput>

This class represents the following YANG schema fragment defined in module path-computation 

 input input {
   leaf graph-name {
     type string;
   }
   leaf source {
     type uint64;
   }
   leaf destination {
     type uint64;
   }
   container constraints {
     uses path-constraints;
   }
   leaf algorithm {
     type algorithm-type;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<GetConstrainedPathInput> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.RpcInput

    • bindingHashCode

      static int bindingHashCode(@NonNull GetConstrainedPathInput obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull GetConstrainedPathInput thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull GetConstrainedPathInput obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • getGraphName

      String getGraphName()
      Return graphName, or null if it is not present.
      Returns:
      String graphName, or null if it is not present.

    • requireGraphName

      default @NonNull String requireGraphName()
      Return graphName, guaranteed to be non-null.
      Returns:
      String graphName, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if graphName is not present

    • getSource

      org.opendaylight.yangtools.yang.common.Uint64 getSource()
      Return source, or null if it is not present.
      Returns:
      Uint64 source, or null if it is not present.

    • requireSource

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireSource()
      Return source, guaranteed to be non-null.
      Returns:
      Uint64 source, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if source is not present

    • getDestination

      org.opendaylight.yangtools.yang.common.Uint64 getDestination()
      Return destination, or null if it is not present.
      Returns:
      Uint64 destination, or null if it is not present.

    • requireDestination

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireDestination()
      Return destination, guaranteed to be non-null.
      Returns:
      Uint64 destination, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if destination is not present

    • getConstraints

      Constraints getConstraints()
      Return constraints, or null if it is not present.
      Returns:
      Constraints constraints, or null if it is not present.

    • nonnullConstraints

      @NonNull Constraints nonnullConstraints()
      Return constraints, or an empty instance if it is not present.
      Returns:
      Constraints constraints, or an empty instance if it is not present.

    • getAlgorithm

      AlgorithmType getAlgorithm()
      Return algorithm, or null if it is not present.
      Returns:
      AlgorithmType algorithm, or null if it is not present.

    • requireAlgorithm

      default @NonNull AlgorithmType requireAlgorithm()
      Return algorithm, guaranteed to be non-null.
      Returns:
      AlgorithmType algorithm, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if algorithm is not present