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

Interface Restconf

All Superinterfaces:

Augmentable<Restconf>, BindingObject, ChildOf<Restconf>, DataContainer, DataObject

public interface Restconf
extends ChildOf<Restconf>, Augmentable<Restconf>

Conceptual container representing the application/yang.api resource type.

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

 container restconf {
   container config {
   }
   container operational {
   }
   container modules {
     list module {
       key "name revision";
       leaf name {
         type yang:yang-identifier;
       }
       leaf revision {
         type union {
           type revision-identifier;
           type string {
             length 0;
           }
         }
       }
       leaf namespace {
         type inet:uri;
       }
       leaf-list feature {
         type yang:yang-identifier;
       }
       leaf-list deviation {
         type yang:yang-identifier;
       }
     }
   }
   container operations {
   }
   container streams {
     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;
       }
     }
   }
   leaf version {
     type enumeration {
       enum 1.0 {
       }
     }
     config false;
   }
 }
 

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

To create instances of this class use RestconfBuilder.

See Also:

RestconfBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Restconf.Version

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 Config	getConfig() Container representing the application/yang.datastoreresource type.
@Nullable Modules	getModules() Contains a list of module description entries.These modules are currently loaded into the server.
@Nullable Operational	getOperational() Container representing the application/yang.datastoreresource type.
@Nullable Operations	getOperations() Container for all operation resources(application/yang.operation),Each resource is represented as an empty leaf with thename of the RPC operation from the YANG rpc statement.E.g.; POST /restconf/operations/show-log-errors leaf show-log-errors { type empty; }
@Nullable Streams	getStreams() Container representing the notification event streamssupported by the server.
@Nullable Restconf.Version	getVersion() Contains the RESTCONF protocol version.

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

getConfig

@Nullable Config getConfig()

Container representing the application/yang.datastoreresource type. Represents the conceptual root of theunified configuration datastore containing YANG datanodes. The child nodes of this container areconfiguration data resources (application/yang.data)defined as top-level YANG data nodes from the modulesadvertised by the server in /restconf/modules.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.Config config, or null if not present

getOperational

@Nullable Operational getOperational()

Container representing the application/yang.datastoreresource type. Represents the conceptual root of theoperational data supported by the server. The childnodes of this container are operational data resources(application/yang.data) defined as top-levelYANG data nodes from the modules advertised bythe server in /restconf/modules.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.Operational operational, or null if not present

getModules

@Nullable Modules getModules()

Contains a list of module description entries.These modules are currently loaded into the server.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.Modules modules, or null if not present

getOperations

@Nullable Operations getOperations()

Container for all operation resources(application/yang.operation),Each resource is represented as an empty leaf with thename of the RPC operation from the YANG rpc statement.E.g.; POST /restconf/operations/show-log-errors leaf show-log-errors { type empty; }

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.Operations operations, or null if not present

getStreams

@Nullable Streams getStreams()

Container representing the notification event streamssupported by the server.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.restconf.Streams streams, or null if not present

getVersion

@Nullable Restconf.Version getVersion()

Contains the RESTCONF protocol version.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.restconf.Restconf.Version version, or null if not present