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

Interface ProtocolsConfig

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:
Config, State
@Generated("mdsal-binding-generator") public interface ProtocolsConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration parameters relating to a generic protocol instance within a network instance

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

 grouping protocols-config {
   leaf identifier {
     type identityref {
       base install-protocol-type;
     }
   }
   leaf name {
     type string;
   }
   leaf enabled {
     type boolean;
   }
   leaf target-table {
     type string;
   }
 }

  • 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 ProtocolsConfig> 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

    • getIdentifier

      InstallProtocolType getIdentifier()
      Return identifier, or null if it is not present. 
           
         The protocol identifier for the instance
      Returns:
      InstallProtocolType identifier, or null if it is not present.

    • requireIdentifier

      default @NonNull InstallProtocolType requireIdentifier()
      Return identifier, guaranteed to be non-null. 
           
         The protocol identifier for the instance
      Returns:
      InstallProtocolType identifier, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if identifier is not present

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         A unique name for the protocol instance
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         A unique name for the protocol instance
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getEnabled

      Boolean getEnabled()
      Return enabled, or null if it is not present. 
           
         A boolean value indicating whether the local protocol instance is enabled.
      Returns:
      Boolean enabled, or null if it is not present.

    • requireEnabled

      default @NonNull Boolean requireEnabled()
      Return enabled, guaranteed to be non-null. 
           
         A boolean value indicating whether the local protocol instance is enabled.
      Returns:
      Boolean enabled, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if enabled is not present

    • getTargetTable

      String getTargetTable()
      Return targetTable, or null if it is not present. 
           
         The table (RIB, FIB, or LFIB) that the protocol should populate its entries in.
      Returns:
      String targetTable, or null if it is not present.

    • requireTargetTable

      default @NonNull String requireTargetTable()
      Return targetTable, guaranteed to be non-null. 
           
         The table (RIB, FIB, or LFIB) that the protocol should populate its entries in.
      Returns:
      String targetTable, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if targetTable is not present