Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes

Interface InterfaceExternalIds

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<InterfaceExternalIds>, 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<InterfaceExternalIdsKey>
    @Generated("mdsal-binding-generator")
public interface InterfaceExternalIds
extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<InterfaceExternalIds>, org.opendaylight.yangtools.yang.binding.Identifiable<InterfaceExternalIdsKey>
    Interface external ids external_ids : attached-mac: optional string. The MAC address programmed into the ''virtual hardware'' for this interface, in the xx:xx:xx:xx:xx:xx. For Citrix XenServer, this is the value of the MAC field in the VIF record for this interface. external_ids : iface-id: optional string. A system-unique identifier for the interface. On XenServer, this will commonly be the same as external_ids:xs-vif-uuid. external_ids : iface-status: optional string either active or inactive Hypervisors may sometimes have more than one interface associated with a given external_ids:iface-id, only one of which is actually in use at a given time. external_ids : xs-vif-uuid: optional string. The virtual interface associated with this interface. external_ids : xs-network-uuid: optional string. The virtual network to which this interface attached. external_ids : vm-id: optional string. The VM to which this interface belongs. On XenServer, this will be the same as external_ids:xsvm-uuid. external_ids : xs-vm-uuid: optional string. The VM to which this interface belongs

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

     list interface-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 InterfaceExternalIdsBuilder.

    See Also:
    InterfaceExternalIdsBuilder, InterfaceExternalIdsKey

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