Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.connection.point.endpoints

Interface Endpoint

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Endpoint>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<Endpoints>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.EntryObject<Endpoint,EndpointKey>, org.opendaylight.yangtools.binding.KeyAware<EndpointKey>
@Generated("mdsal-binding-generator") public interface Endpoint extends org.opendaylight.yangtools.binding.ChildOf<Endpoints>, org.opendaylight.yangtools.binding.EntryObject<Endpoint,EndpointKey>
A list of the endpoints (interfaces or remote connection points that can be for this connection point). The active endpoint is selected based on the precedence that it is configured with

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

 list endpoint {
   key endpoint-id;
   leaf endpoint-id {
     type leafref {
       path ../config/endpoint-id;
     }
   }
   container config {
     uses instance-endpoint-config;
   }
   container state {
     config false;
     uses instance-endpoint-config;
     uses instance-endpoint-state;
   }
 }

To create instances of this class use EndpointBuilder.

See Also:

  • 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

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

    • bindingHashCode

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

    • key

      EndpointKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.binding.KeyAware<EndpointKey>

    • getEndpointId

      String getEndpointId()
      Return endpointId, or null if it is not present. 
           
         A pointer to the configured identifier for the endpoint
      Returns:
      String endpointId, or null if it is not present.

    • requireEndpointId

      default @NonNull String requireEndpointId()
      Return endpointId, guaranteed to be non-null. 
           
         A pointer to the configured identifier for the endpoint
      Returns:
      String endpointId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if endpointId is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configuration parameters relating to the endpoint
      Returns:
      Config config, or null if it is not present.

    • nonnullConfig

      @NonNull Config nonnullConfig()
      Return config, or an empty instance if it is not present.
      Returns:
      Config config, or an empty instance if it is not present.

    • getState

      State getState()
      Return state, or null if it is not present. 
           
         Operational state parameters relating to the endpoint
      Returns:
      State state, or null if it is not present.

    • nonnullState

      @NonNull State nonnullState()
      Return state, or an empty instance if it is not present.
      Returns:
      State state, or an empty instance if it is not present.