Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018

Interface InstanceEndpointState

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
State
@Generated("mdsal-binding-generator") public interface InstanceEndpointState extends org.opendaylight.yangtools.yang.binding.DataObject
Operational state data relating to a forwarding-instance endpoint

This class represents the following YANG schema fragment defined in module openconfig-network-instance 

 grouping instance-endpoint-state {
   leaf active {
     type boolean;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getActive()
    Return active, or null if it is not present.
    Class<? extends InstanceEndpointState>
    implementedInterface()
     
    default @NonNull Boolean
    requireActive()
    Return active, guaranteed to be non-null.

  • 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

      Class<? extends InstanceEndpointState> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getActive

      Boolean getActive()
      Return active, or null if it is not present. 
           
         When the backup endpoint is active, the value of this parameter is set to true
      Returns:
      Boolean active, or null if it is not present.

    • requireActive

      default @NonNull Boolean requireActive()
      Return active, guaranteed to be non-null. 
           
         When the backup endpoint is active, the value of this parameter is set to true
      Returns:
      Boolean active, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if active is not present