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

Interface BackupDatastoreInput

All Superinterfaces:

Augmentable<BackupDatastoreInput>, BindingObject, DataContainer, DataObject, RpcInput

@Generated("mdsal-binding-generator")
public interface BackupDatastoreInput
extends RpcInput, Augmentable<BackupDatastoreInput>

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

 input input {
   leaf file-path {
     type string;
   }
   leaf timeout {
     type uint32 {
       range 1..max;
     }
     units seconds;
   }
 }
 

The schema path to identify an instance is cluster-admin/backup-datastore/input

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull QName	QNAME

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull BackupDatastoreInput thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull BackupDatastoreInput obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull BackupDatastoreInput obj)	Default implementation of Object.toString() contract for this interface.
String	getFilePath()	Return filePath, or null if it is not present.
Uint32	getTimeout()	Return timeout, or null if it is not present.
default Class<BackupDatastoreInput>	implementedInterface()
default @NonNull String	requireFilePath()	Return filePath, guaranteed to be non-null.
default @NonNull Uint32	requireTimeout()	Return timeout, guaranteed to be non-null.

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

augmentation, augmentations

Field Detail

QNAME

static final @NonNull QName QNAME

Method Detail

implementedInterface

default Class<BackupDatastoreInput> implementedInterface()

Specified by:

implementedInterface in interface DataContainer

Specified by:

implementedInterface in interface DataObject

Specified by:

implementedInterface in interface RpcInput

bindingHashCode

static int bindingHashCode(@NonNull BackupDatastoreInput obj)

Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.

Parameters:

obj - Object for which to generate hashCode() result.

Returns:

Hash code value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

bindingEquals

static boolean bindingEquals(@NonNull BackupDatastoreInput thisObj,
                             Object obj)

Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.

Parameters:

thisObj - Object acting as the receiver of equals invocation

obj - Object acting as argument to equals invocation

Returns:

True if thisObj and obj are considered equal

Throws:

NullPointerException - if thisObj is null

bindingToString

static String bindingToString(@NonNull BackupDatastoreInput obj)

Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.

Parameters:

obj - Object for which to generate toString() result.

Returns:

String value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

getFilePath

String getFilePath()

Return filePath, or null if it is not present.

     
         The path and name of the file in which to store the backup.
     
 

Returns:

String filePath, or null if it is not present.

requireFilePath

default @NonNull String requireFilePath()

Return filePath, guaranteed to be non-null.

     
         The path and name of the file in which to store the backup.
     
 

Returns:

String filePath, guaranteed to be non-null.

Throws:

NoSuchElementException - if filePath is not present

getTimeout

Uint32 getTimeout()

Return timeout, or null if it is not present.

     
         Optional timeout in seconds for the backup operation which will override all the
         different timeouts that are being hit on the backend.
     
 

Returns:

Uint32 timeout, or null if it is not present.

requireTimeout

default @NonNull Uint32 requireTimeout()

Return timeout, guaranteed to be non-null.

     
         Optional timeout in seconds for the backup operation which will override all the
         different timeouts that are being hit on the backend.
     
 

Returns:

Uint32 timeout, guaranteed to be non-null.

Throws:

NoSuchElementException - if timeout is not present