Interface BridgeExternalIds

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BridgeExternalIds>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbBridgeAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<BridgeExternalIdsKey>

    @Generated("mdsal-binding-generator")
    public interface BridgeExternalIds
    extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbBridgeAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<BridgeExternalIds>, org.opendaylight.yangtools.yang.binding.Identifiable<BridgeExternalIdsKey>
    Key-value pairs for use by external frameworks that integrate with Open external_ids : bridge-id: optional string A unique identifier of the bridge. On Citrix XenServer this will commonly be the same as external_ids:xs-network-uuids. external_ids : xs-network-uuids: optional string Semicolon-delimited set of universally unique identifier(s) for the network which this bridge is associated on a Citrix XenServer host. The network identifiers are RFC 4122 UUIDs as displayed by, e.g., xe network-list.

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

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

    To create instances of this class use BridgeExternalIdsBuilder.

    See Also:
    BridgeExternalIdsBuilder, BridgeExternalIdsKey
    • 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<BridgeExternalIds> 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 BridgeExternalIds 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 BridgeExternalIds 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 BridgeExternalIds 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
      • getBridgeExternalIdKey

        String getBridgeExternalIdKey()
        Return bridgeExternalIdKey, or null if it is not present.
             
                 external-id name/key
             
         
        Returns:
        String bridgeExternalIdKey, or null if it is not present.
      • requireBridgeExternalIdKey

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

        String getBridgeExternalIdValue()
        Return bridgeExternalIdValue, or null if it is not present.
             
                 bridge-external-id value
             
         
        Returns:
        String bridgeExternalIdValue, or null if it is not present.
      • requireBridgeExternalIdValue

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