org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.streams

Interface Stream

All Superinterfaces:

Augmentable<Stream>, BindingObject, ChildOf<Streams>, DataContainer, DataObject, Identifiable<StreamKey>

public interface Stream
extends ChildOf<Streams>, Augmentable<Stream>, Identifiable<StreamKey>

Each entry describes an event stream supported by the server.

This class represents the following YANG schema fragment defined in module ietf-restconf

 list stream {
   key name;
   leaf name {
     type string;
   }
   leaf description {
     type string;
   }
   leaf replay-support {
     type boolean;
   }
   leaf replay-log-creation-time {
     type yang:date-and-time;
   }
   leaf events {
     type empty;
   }
 }
 

The schema path to identify an instance is ietf-restconf/restconf/restconf/streams/stream

To create instances of this class use StreamBuilder.

See Also:

StreamBuilder, StreamKey

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable String	getDescription() Description of stream content
@Nullable String	getName() The stream name
@Nullable DateAndTime	getReplayLogCreationTime() Indicates the time the replay log for this streamwas created.
@Nullable Boolean	isEvents() Represents the entry point for establishingnotification delivery via server sent events.
@Nullable Boolean	isReplaySupport() Indicates if replay buffer supported for this stream
StreamKey	key() Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

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

Method Detail

getName

@Nullable String getName()

The stream name

Returns:

java.lang.String name, or null if not present

getDescription

@Nullable String getDescription()

Description of stream content

Returns:

java.lang.String description, or null if not present

isReplaySupport

@Nullable Boolean isReplaySupport()

Indicates if replay buffer supported for this stream

Returns:

java.lang.Boolean replaySupport, or null if not present

getReplayLogCreationTime

@Nullable DateAndTime getReplayLogCreationTime()

Indicates the time the replay log for this streamwas created.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime replayLogCreationTime, or null if not present

isEvents

@Nullable Boolean isEvents()

Represents the entry point for establishingnotification delivery via server sent events.

Returns:

java.lang.Boolean events, or null if not present

key

StreamKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<StreamKey>

Returns:

Key for the object