Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.gnmi.node.state

Interface NodeState

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NodeState>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<GnmiNodeState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface NodeState
extends org.opendaylight.yangtools.yang.binding.ChildOf<GnmiNodeState>, org.opendaylight.yangtools.yang.binding.Augmentable<NodeState>

    This class represents the following YANG schema fragment defined in module gnmi-topology 

     container node-state {
   leaf node-status {
     config false;
     type enumeration {
       enum READY;
       enum CONNECTING;
       enum TRANSIENT_FAILURE;
       enum IDLE;
       enum SHUTDOWN;
       enum FAILURE;
     }
   }
   leaf failure-details {
     when "../node-status='FAILURE'";
     config false;
     type string;
   }
   container available-capabilities {
     config false;
     list available-capability {
       leaf capability {
         type string;
       }
     }
   }
 }

    To create instances of this class use NodeStateBuilder.

    See Also:
    NodeStateBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<NodeState> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull NodeState 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 NodeState 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 NodeState 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

      • getNodeStatus

        NodeState.NodeStatus getNodeStatus()
        Return nodeStatus, or null if it is not present.
        Returns:
        NodeStatus nodeStatus, or null if it is not present.

      • requireNodeStatus

        default @NonNull NodeState.NodeStatus requireNodeStatus()
        Return nodeStatus, guaranteed to be non-null.
        Returns:
        NodeStatus nodeStatus, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if nodeStatus is not present

      • getFailureDetails

        String getFailureDetails()
        Return failureDetails, or null if it is not present. 
             
         Details about the reason for the connection failure. The failure-details field
         is associated only with FAILURE node-status.
        Returns:
        String failureDetails, or null if it is not present.

      • requireFailureDetails

        default @NonNull String requireFailureDetails()
        Return failureDetails, guaranteed to be non-null. 
             
         Details about the reason for the connection failure. The failure-details field
         is associated only with FAILURE node-status.
        Returns:
        String failureDetails, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if failureDetails is not present

      • getAvailableCapabilities

        AvailableCapabilities getAvailableCapabilities()
        Return availableCapabilities, or null if it is not present. 
             
         Resulting capabilities of the gNMI device based on supported_models field
         contained in CapabilityResponse which are used for constructing schema context
         for device's mount point.
        Returns:
        AvailableCapabilities availableCapabilities, or null if it is not present.