Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013

Interface ShardOperationResult

All Superinterfaces:

BindingObject, DataContainer, DataObject, DatastoreShardId

All Known Subinterfaces:

ShardResult

@Generated("mdsal-binding-generator")
public interface ShardOperationResult
extends DataObject, DatastoreShardId

This class represents the following YANG schema fragment defined in module cluster-admin

 grouping shard-operation-result {
   uses datastore-shard-id;
   leaf succeeded {
     type boolean;
   }
   leaf error-message {
     type string;
   }
 }
 

The schema path to identify an instance is cluster-admin/shard-operation-result

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull QName	QNAME

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()	Return errorMessage, or null if it is not present.
Boolean	getSucceeded()	Return succeeded, or null if it is not present.
Class<? extends ShardOperationResult>	implementedInterface()
default @NonNull String	requireErrorMessage()	Return errorMessage, guaranteed to be non-null.
default @NonNull Boolean	requireSucceeded()	Return succeeded, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.DatastoreShardId

getDataStoreType, getShardName, requireDataStoreType, requireShardName

Field Detail

QNAME

static final @NonNull QName QNAME

Method Detail

implementedInterface

Class<? extends ShardOperationResult> implementedInterface()

Specified by:

implementedInterface in interface DataContainer

Specified by:

implementedInterface in interface DataObject

Specified by:

implementedInterface in interface DatastoreShardId

getSucceeded

Boolean getSucceeded()

Return succeeded, or null if it is not present.

Returns:

Boolean succeeded, or null if it is not present.

requireSucceeded

default @NonNull Boolean requireSucceeded()

Return succeeded, guaranteed to be non-null.

Returns:

Boolean succeeded, guaranteed to be non-null.

Throws:

NoSuchElementException - if succeeded is not present

getErrorMessage

String getErrorMessage()

Return errorMessage, or null if it is not present.

Returns:

String errorMessage, or null if it is not present.

requireErrorMessage

default @NonNull String requireErrorMessage()

Return errorMessage, guaranteed to be non-null.

Returns:

String errorMessage, guaranteed to be non-null.

Throws:

NoSuchElementException - if errorMessage is not present