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

Interface YangPatchStatus

All Superinterfaces:

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

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

A container representing the response message sent by the server after a YANG Patch edit request message has been processed.

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

 container yang-patch-status {
   leaf patch-id {
     type string;
   }
   choice global-status {
     case global-errors {
       uses errors;
     }
     case ok {
       leaf ok {
         type empty;
       }
     }
   }
   container edit-status {
     list edit {
       key edit-id;
       leaf edit-id {
         type string;
       }
       choice edit-status-choice {
         case ok {
           leaf ok {
             type empty;
           }
         }
         case location {
           leaf location {
             type inet:uri;
           }
         }
         case errors {
           uses errors;
         }
       }
     }
   }
 }
 

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

To create instances of this class use YangPatchStatusBuilder.

See Also:

YangPatchStatusBuilder

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 EditStatus	getEditStatus() This container will be present if there areedit-specific status responses to report.
@Nullable GlobalStatus	getGlobalStatus() Report global errors or complete success.If there is no case selected then errorsare reported in the edit-status container.
@Nullable String	getPatchId() The patch-id value used in the request

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

getPatchId

@Nullable String getPatchId()

The patch-id value used in the request

Returns:

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

getGlobalStatus

@Nullable GlobalStatus getGlobalStatus()

Report global errors or complete success.If there is no case selected then errorsare reported in the edit-status container.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.yang.patch.status.yang.patch.status.GlobalStatus globalStatus, or null if not present

getEditStatus

@Nullable EditStatus getEditStatus()

This container will be present if there areedit-specific status responses to report.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.rev131019.yang.patch.status.yang.patch.status.EditStatus editStatus, or null if not present