Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.gnmi.connection.parameters.extensions.parameters

Interface GnmiParameters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<GnmiParameters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ExtensionsParameters>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface GnmiParameters
extends org.opendaylight.yangtools.yang.binding.ChildOf<ExtensionsParameters>, org.opendaylight.yangtools.yang.binding.Augmentable<GnmiParameters>

    This class represents the following YANG schema fragment defined in module gnmi-topology 

     container gnmi-parameters {
   leaf overwrite-data-type {
     type enumeration {
       enum ALL;
       enum CONFIG;
       enum STATE;
       enum OPERATIONAL;
       enum UNRECOGNIZED;
       enum NONE;
     }
   }
   leaf use-model-name-prefix {
     type boolean;
     default false;
   }
   leaf path-target {
     type string;
   }
 }
    The schema path to identify an instance is gnmi-topologygnmi-connection-parametersextensions-parametersgnmi-parameters

    To create instances of this class use GnmiParametersBuilder.

    See Also:
    GnmiParametersBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • bindingHashCode

        static int bindingHashCode​(@NonNull GnmiParameters 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 GnmiParameters 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 GnmiParameters 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

      • getOverwriteDataType

        GnmiParameters.OverwriteDataType getOverwriteDataType()
        Return overwriteDataType, or null if it is not present. 
             
         Overwrites the type field of gNMI GetRequest. If not set, the type field is
         automatically set to CONFIG/STATE based on the RESTCONF content query parameter.
         This setting is useful in cases where the device does not support GetRequest
         with CONFIG/STATE type field.
        Returns:
        OverwriteDataType overwriteDataType, or null if it is not present.

      • requireOverwriteDataType

        default @NonNull GnmiParameters.OverwriteDataType requireOverwriteDataType()
        Return overwriteDataType, guaranteed to be non-null. 
             
         Overwrites the type field of gNMI GetRequest. If not set, the type field is
         automatically set to CONFIG/STATE based on the RESTCONF content query parameter.
         This setting is useful in cases where the device does not support GetRequest
         with CONFIG/STATE type field.
        Returns:
        OverwriteDataType overwriteDataType, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if overwriteDataType is not present

      • getUseModelNamePrefix

        Boolean getUseModelNamePrefix()
        Return useModelNamePrefix, or null if it is not present. 
             
         Some devices require a module prefix in first element name of gNMI request path
         (e.g interfaces -&gt; openconfig-interfaces:interfaces). When flag
         use-model-name-prefix is set to true for device, YIID will be transformed into
         gNMI path where elements have their module name. E.g. element interfaces from
         module openconfig-interfaces will be transformed as
         openconfig-interfaces:interfaces
        Returns:
        Boolean useModelNamePrefix, or null if it is not present.

      • requireUseModelNamePrefix

        default @NonNull Boolean requireUseModelNamePrefix()
        Return useModelNamePrefix, guaranteed to be non-null. 
             
         Some devices require a module prefix in first element name of gNMI request path
         (e.g interfaces -&gt; openconfig-interfaces:interfaces). When flag
         use-model-name-prefix is set to true for device, YIID will be transformed into
         gNMI path where elements have their module name. E.g. element interfaces from
         module openconfig-interfaces will be transformed as
         openconfig-interfaces:interfaces
        Returns:
        Boolean useModelNamePrefix, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if useModelNamePrefix is not present

      • getPathTarget

        String getPathTarget()
        Return pathTarget, or null if it is not present. 
             
         The path-target field is used to specify the context of a particular stream of
         data. The data stream can be intended for individual target datastores. Only set
         in prefix for a path. This field MUST only ever be present on prefix paths in
         the corresponding request and response messages. This field is optional for
         clients.
        Returns:
        String pathTarget, or null if it is not present.

      • requirePathTarget

        default @NonNull String requirePathTarget()
        Return pathTarget, guaranteed to be non-null. 
             
         The path-target field is used to specify the context of a particular stream of
         data. The data stream can be intended for individual target datastores. Only set
         in prefix for a path. This field MUST only ever be present on prefix paths in
         the corresponding request and response messages. This field is optional for
         clients.
        Returns:
        String pathTarget, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if pathTarget is not present