Interface PortExternalIds

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PortExternalIds>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PortExternalIdsKey>

    @Generated("mdsal-binding-generator")
    public interface PortExternalIds
    extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<PortExternalIds>, org.opendaylight.yangtools.yang.binding.Identifiable<PortExternalIdsKey>
    Port external ids external_ids : fake-bridge-id-*: optional string External IDs for a fake bridge (see the fake_bridge column) are defined by prefixing a external_ids key with fake-bridge-, e.g. fake-bridge-xs-network-uuids.

    This class represents the following YANG schema fragment defined in module ovsdb

     list port-external-ids {
       key external-id-key;
       leaf external-id-key {
         type string;
       }
       leaf external-id-value {
         type string;
       }
     }
     

    To create instances of this class use PortExternalIdsBuilder.

    See Also:
    PortExternalIdsBuilder, PortExternalIdsKey
    • 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<PortExternalIds> 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 PortExternalIds 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 PortExternalIds 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 PortExternalIds 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
      • getExternalIdKey

        String getExternalIdKey()
        Return externalIdKey, or null if it is not present.
             
                 external-id name/key
             
         
        Returns:
        String externalIdKey, or null if it is not present.
      • requireExternalIdKey

        default @NonNull String requireExternalIdKey()
        Return externalIdKey, guaranteed to be non-null.
             
                 external-id name/key
             
         
        Returns:
        String externalIdKey, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if externalIdKey is not present
      • getExternalIdValue

        String getExternalIdValue()
        Return externalIdValue, or null if it is not present.
             
                 external-id value
             
         
        Returns:
        String externalIdValue, or null if it is not present.
      • requireExternalIdValue

        default @NonNull String requireExternalIdValue()
        Return externalIdValue, guaranteed to be non-null.
             
                 external-id value
             
         
        Returns:
        String externalIdValue, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if externalIdValue is not present