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

Interface YangPatch

All Superinterfaces:

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

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

Represents a conceptual sequence of datastore edits, called a patch. Each patch is given a client-assigned patch identifier. Each edit MUST be applied in ascending order, and all edits MUST be applied. If any errors occur, then the target datastore MUST NOT be changed by the patch operation. A patch MUST be validated by the server to be a well-formed message before any of the patch edits are validated or attempted. YANG datastore validation (defined in RFC 6020, section 8.3.3) is performed after all edits have been individually validated. It is possible for a datastore constraint violation to occur due to any node in the datastore, including nodes not included in the edit list. Any validation errors MUST be reported in the reply message.

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

 container yang-patch {
   leaf patch-id {
     type string;
   }
   leaf comment {
     type string {
       length "0 .. 1024";
     }
   }
   list edit {
     key edit-id;
     ordered-by user;
     leaf edit-id {
       type string;
     }
     leaf operation {
       type enumeration {
         enum create {
         }
         enum delete {
         }
         enum insert {
         }
         enum merge {
         }
         enum move {
         }
         enum replace {
         }
         enum remove {
         }
       }
     }
     leaf target {
       type data-resource-identifier;
     }
     leaf point {
       when "(../operation = 'insert' or ../operation = 'move') and (../where = 'before' or ../where = 'after')" {
       }
       type data-resource-identifier;
     }
     leaf where {
       when "../operation = 'insert' or ../operation = 'move'" {
       }
       type enumeration {
         enum before {
         }
         enum after {
         }
         enum first {
         }
         enum last {
         }
       }
       default last;
     }
     anyxml value {
       when "(../operation = 'create' or ../operation = 'merge' or ../operation = 'replace' or ../operation = 'insert')" {
       }
     }
   }
 }
 

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

To create instances of this class use YangPatchBuilder.

See Also:

YangPatchBuilder

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	getComment() An arbitrary string provided by the client to describethe entire patch.
@Nullable List<Edit>	getEdit() Represents one edit within the YANG Patchrequest message.
@Nullable String	getPatchId() An arbitrary string provided by the client to identifythe entire patch.
default @NonNull List<Edit>	nonnullEdit()

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()

An arbitrary string provided by the client to identifythe entire patch. This value SHOULD be present in anyaudit logging records generated by the server for thepatch. Error messages returned by the server pertainingto this patch will be identified by this patch-id value.

Returns:

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

getComment

@Nullable String getComment()

An arbitrary string provided by the client to describethe entire patch. This value SHOULD be present in anyaudit logging records generated by the server for thepatch.

Returns:

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

getEdit

@Nullable List<Edit> getEdit()

Represents one edit within the YANG Patchrequest message.

Returns:

java.util.List edit, or null if not present

nonnullEdit

default @NonNull List<Edit> nonnullEdit()

Returns:

java.util.List edit, or an empty list if it is not present