Interface ConnectionParameters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ConnectionParameters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<GnmiConnectionParameters>, Credentials, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Security

    @Generated("mdsal-binding-generator")
    public interface ConnectionParameters
    extends org.opendaylight.yangtools.yang.binding.ChildOf<GnmiConnectionParameters>, org.opendaylight.yangtools.yang.binding.Augmentable<ConnectionParameters>, Security

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

     container connection-parameters {
       leaf host {
         type inet:host;
       }
       leaf port {
         type inet:port-number;
       }
       uses security;
     }
     
    The schema path to identify an instance is gnmi-topologygnmi-connection-parametersconnection-parameters

    To create instances of this class use ConnectionParametersBuilder.

    See Also:
    ConnectionParametersBuilder
    • Field Detail

      • QNAME

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

      • bindingHashCode

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

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host getHost()
        Return host, or null if it is not present.
             
                 IP address or hostname of the target
             
         
        Returns:
        Host host, or null if it is not present.
      • requireHost

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host requireHost()
        Return host, guaranteed to be non-null.
             
                 IP address or hostname of the target
             
         
        Returns:
        Host host, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if host is not present
      • getPort

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
        Return port, or null if it is not present.
             
                 The port number on which to contact the target
             
         
        Returns:
        PortNumber port, or null if it is not present.
      • requirePort

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requirePort()
        Return port, guaranteed to be non-null.
             
                 The port number on which to contact the target
             
         
        Returns:
        PortNumber port, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if port is not present