Interface Endpoint

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Endpoint>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Endpoints>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<EndpointKey>

    public interface Endpoint
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Endpoints>, org.opendaylight.yangtools.yang.binding.Augmentable<Endpoint>, org.opendaylight.yangtools.yang.binding.Identifiable<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;
       }
     }
     
    The schema path to identify an instance is openconfig-network-instance/network-instance-top/network-instances/network-instance/connection-points/connection-point/endpoints/endpoint

    To create instances of this class use EndpointBuilder.

    See Also:
    EndpointBuilder, EndpointKey
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        @Nullable String getEndpointId()
        A pointer to the configured identifier for the endpoint
        Returns:
        java.lang.String endpointId, or null if not present
      • getConfig

        @Nullable Config getConfig()
        Configuration parameters relating to the endpoint
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.connection.point.endpoints.endpoint.Config config, or null if not present
      • getState

        @Nullable State getState()
        Operational state parameters relating to the endpoint
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.connection.point.endpoints.endpoint.State state, or null if not present
      • key

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