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

Interface LicenseConfig

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Config, State
@Generated("mdsal-binding-generator") public interface LicenseConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration data for license

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

 grouping license-config {
   leaf license-id {
     type string;
   }
   leaf license-data {
     type union {
       type binary;
       type string;
     }
   }
   leaf active {
     type boolean;
     default false;
   }
 }

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

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

    • getLicenseId

      String getLicenseId()
      Return licenseId, or null if it is not present. 
           
         License ID. A string that uniquelly identifies the license. The platform should
         list all the licenses it supports being activated.
      Returns:
      String licenseId, or null if it is not present.

    • requireLicenseId

      default @NonNull String requireLicenseId()
      Return licenseId, guaranteed to be non-null. 
           
         License ID. A string that uniquelly identifies the license. The platform should
         list all the licenses it supports being activated.
      Returns:
      String licenseId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if licenseId is not present

    • getLicenseData

      LicenseConfig.LicenseData getLicenseData()
      Return licenseData, or null if it is not present. 
           
         The contents of the licence (if required) - which may be supplied as a binary
         blob, or a simple string value. If this value is considered sensitive, it may be
         read as an empty value.
      Returns:
      LicenseData licenseData, or null if it is not present.

    • requireLicenseData

      default @NonNull LicenseConfig.LicenseData requireLicenseData()
      Return licenseData, guaranteed to be non-null. 
           
         The contents of the licence (if required) - which may be supplied as a binary
         blob, or a simple string value. If this value is considered sensitive, it may be
         read as an empty value.
      Returns:
      LicenseData licenseData, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if licenseData is not present

    • getActive

      Boolean getActive()
      Return active, or null if it is not present. 
           
         The activation state of the license.
      Returns:
      Boolean active, or null if it is not present.

    • requireActive

      default @NonNull Boolean requireActive()
      Return active, guaranteed to be non-null. 
           
         The activation state of the license.
      Returns:
      Boolean active, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if active is not present