Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.license.rev200422

Interface LicenseState

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    State
    @Generated("mdsal-binding-generator")
public interface LicenseState
extends org.opendaylight.yangtools.yang.binding.DataObject
    State data for license

    This class represents the following YANG schema fragment defined in module openconfig-license 

     grouping license-state {
   leaf description {
     type string;
   }
   leaf issue-date {
     type uint64;
   }
   leaf expiration-date {
     type uint64;
   }
   leaf in-use {
     type boolean;
   }
   leaf expired {
     type boolean;
   }
   leaf valid {
     type boolean;
   }
 }
    The schema path to identify an instance is openconfig-licenselicense-state

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        Class<? extends LicenseState> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getDescription

        String getDescription()
        Return description, or null if it is not present. 
             
         The license description.
        Returns:
        String description, or null if it is not present.

      • requireDescription

        default @NonNull String requireDescription()
        Return description, guaranteed to be non-null. 
             
         The license description.
        Returns:
        String description, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if description is not present

      • getIssueDate

        org.opendaylight.yangtools.yang.common.Uint64 getIssueDate()
        Return issueDate, or null if it is not present. 
             
         The date and time at which the license was issued, expressed as the number of
         nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).
        Returns:
        Uint64 issueDate, or null if it is not present.

      • requireIssueDate

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireIssueDate()
        Return issueDate, guaranteed to be non-null. 
             
         The date and time at which the license was issued, expressed as the number of
         nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).
        Returns:
        Uint64 issueDate, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if issueDate is not present

      • getExpirationDate

        org.opendaylight.yangtools.yang.common.Uint64 getExpirationDate()
        Return expirationDate, or null if it is not present. 
             
         The date and time at which the license will expire, expressed as the number of
         nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC). Zero if it does
         not expire.
        Returns:
        Uint64 expirationDate, or null if it is not present.

      • requireExpirationDate

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireExpirationDate()
        Return expirationDate, guaranteed to be non-null. 
             
         The date and time at which the license will expire, expressed as the number of
         nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC). Zero if it does
         not expire.
        Returns:
        Uint64 expirationDate, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if expirationDate is not present

      • getInUse

        Boolean getInUse()
        Return inUse, or null if it is not present. 
             
         The license is in use. Different from active. This states that the license is
         effectively being used in addition to being active. If license for feature X was
         activated but feature X is not being used, then this should be false.
        Returns:
        Boolean inUse, or null if it is not present.

      • requireInUse

        default @NonNull Boolean requireInUse()
        Return inUse, guaranteed to be non-null. 
             
         The license is in use. Different from active. This states that the license is
         effectively being used in addition to being active. If license for feature X was
         activated but feature X is not being used, then this should be false.
        Returns:
        Boolean inUse, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inUse is not present

      • getExpired

        Boolean getExpired()
        Return expired, or null if it is not present. 
             
         The license has expired.
        Returns:
        Boolean expired, or null if it is not present.

      • requireExpired

        default @NonNull Boolean requireExpired()
        Return expired, guaranteed to be non-null. 
             
         The license has expired.
        Returns:
        Boolean expired, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if expired is not present

      • getValid

        Boolean getValid()
        Return valid, or null if it is not present. 
             
         The license is valid. Can be activated in the system or platform.
        Returns:
        Boolean valid, or null if it is not present.

      • requireValid

        default @NonNull Boolean requireValid()
        Return valid, guaranteed to be non-null. 
             
         The license is valid. Can be activated in the system or platform.
        Returns:
        Boolean valid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if valid is not present