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>
@Generated("mdsal-binding-generator") 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 withThis 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/endpointTo create instances of this class use
EndpointBuilder
.- See Also:
EndpointBuilder
,EndpointKey
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull Endpoint thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Endpoint obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Endpoint obj)
Default implementation ofObject.toString()
contract for this interface.Config
getConfig()
Return config, ornull
if it is not present.String
getEndpointId()
Return endpointId, ornull
if it is not present.State
getState()
Return state, ornull
if it is not present.default Class<Endpoint>
implementedInterface()
EndpointKey
key()
-
-
-
Method Detail
-
implementedInterface
default Class<Endpoint> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull Endpoint obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Endpoint thisObj, Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull Endpoint obj)
Default implementation ofObject.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
- ifobj
is null
-
getEndpointId
String getEndpointId()
Return endpointId, ornull
if it is not present.A pointer to the configured identifier for the endpoint
- Returns:
java.lang.String
endpointId, ornull
if it is not present.
-
getConfig
Config getConfig()
Return config, ornull
if it is not present.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, ornull
if it is not present.
-
getState
State getState()
Return state, ornull
if it is not present.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, ornull
if it is not present.
-
key
EndpointKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<EndpointKey>
-
-