Interface RecoverInput

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<RecoverInput>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.RpcInput

    @Generated("mdsal-binding-generator")
    public interface RecoverInput
    extends org.opendaylight.yangtools.yang.binding.RpcInput, org.opendaylight.yangtools.yang.binding.Augmentable<RecoverInput>

    This class represents the following YANG schema fragment defined in module odl-srm-rpcs

     input input {
       leaf entity-name {
         type identityref {
           base entity-name-base;
         }
       }
       leaf entity-type {
         type identityref {
           base entity-type-base;
         }
       }
       leaf entity-id {
         type string;
       }
     }
     
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<RecoverInput> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.RpcInput
      • bindingHashCode

        static int bindingHashCode​(@NonNull RecoverInput 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 RecoverInput 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 RecoverInput 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
      • getEntityName

        Class<? extends EntityNameBase> getEntityName()
        Return entityName, or null if it is not present.
        Returns:
        Class<? extends EntityNameBase> entityName, or null if it is not present.
      • requireEntityName

        default @NonNull Class<? extends EntityNameBase> requireEntityName()
        Return entityName, guaranteed to be non-null.
        Returns:
        Class<? extends EntityNameBase> entityName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if entityName is not present
      • getEntityType

        Class<? extends EntityTypeBase> getEntityType()
        Return entityType, or null if it is not present.
             
                 Currently supported entity-types: service, instance
             
         
        Returns:
        Class<? extends EntityTypeBase> entityType, or null if it is not present.
      • requireEntityType

        default @NonNull Class<? extends EntityTypeBase> requireEntityType()
        Return entityType, guaranteed to be non-null.
             
                 Currently supported entity-types: service, instance
             
         
        Returns:
        Class<? extends EntityTypeBase> entityType, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if entityType is not present
      • getEntityId

        String getEntityId()
        Return entityId, or null if it is not present.
             
                 Optional when entity-type is service. Actual id depends on entity-type and
                 entity-name
             
         
        Returns:
        String entityId, or null if it is not present.
      • requireEntityId

        default @NonNull String requireEntityId()
        Return entityId, guaranteed to be non-null.
             
                 Optional when entity-type is service. Actual id depends on entity-type and
                 entity-name
             
         
        Returns:
        String entityId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if entityId is not present