Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams

Interface Stream

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Stream>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Streams>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<StreamKey>
    @Generated("mdsal-binding-generator")
public interface Stream
extends org.opendaylight.yangtools.yang.binding.ChildOf<Streams>, org.opendaylight.yangtools.yang.binding.Augmentable<Stream>, org.opendaylight.yangtools.yang.binding.Identifiable<StreamKey>
    Stream name, description and other information.

    This class represents the following YANG schema fragment defined in module nc-notifications 

     list stream {
   key name;
   min-elements 1;
   leaf name {
     type ncEvent:streamNameType;
   }
   leaf description {
     type string;
   }
   leaf replaySupport {
     type boolean;
   }
   leaf replayLogCreationTime {
     type yang:date-and-time;
   }
 }
    The schema path to identify an instance is nc-notifications/netconf/streams/stream

    To create instances of this class use StreamBuilder.

    See Also:
    StreamBuilder, StreamKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default Class<Stream> 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 Stream 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 Stream 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 Stream 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

      • getName

        StreamNameType getName()
        Return name, or null if it is not present. 
             
         The name of the event stream. If this is the default NETCONF stream, this must
         have the value 'NETCONF'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType name, or null if it is not present.

      • getDescription

        String getDescription()
        Return description, or null if it is not present. 
             
         A description of the event stream, including such information as the type of
         events that are sent over this stream.
        Returns:
        java.lang.String description, or null if it is not present.

      • getReplaySupport

        Boolean getReplaySupport()
        Return replaySupport, or null if it is not present. 
             
         A description of the event stream, including such information as the type of
         events that are sent over this stream.
        Returns:
        java.lang.Boolean replaySupport, or null if it is not present.

      • isReplaySupport

        @Deprecated(forRemoval=true)
default Boolean isReplaySupport()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getReplayLogCreationTime

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getReplayLogCreationTime()
        Return replayLogCreationTime, or null if it is not present. 
             
         The timestamp of the creation of the log used to support the replay function on
         this stream. Note that this might be earlier then the earliest available
         notification in the log. This object is updated if the log resets for some
         reason. This object MUST be present if replay is supported.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime replayLogCreationTime, or null if it is not present.

      • key

        StreamKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<StreamKey>