All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: State

@Generated("mdsal-binding-generator")
public interface PlatformComponentState
extends org.opendaylight.yangtools.yang.binding.DataObject

Operational state data for device components.

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

 grouping platform-component-state {
   leaf type {
     type union {
       type identityref {
         base OPENCONFIG_HARDWARE_COMPONENT;
       }
       type identityref {
         base OPENCONFIG_SOFTWARE_COMPONENT;
       }
     }
   }
   leaf id {
     type string;
   }
   leaf location {
     type string;
   }
   leaf description {
     type string;
   }
   leaf mfg-name {
     type string;
   }
   leaf mfg-date {
     type oc-yang:date;
   }
   leaf hardware-version {
     type string;
   }
   leaf firmware-version {
     type string;
   }
   leaf software-version {
     type string;
   }
   leaf serial-no {
     type string;
   }
   leaf part-no {
     type string;
   }
   leaf removable {
     type boolean;
   }
   leaf oper-status {
     type identityref {
       base COMPONENT_OPER_STATUS;
     }
   }
   leaf empty {
     type boolean;
     default false;
   }
   leaf parent {
     type leafref {
       path ../../../component/config/name;
     }
   }
 }

The schema path to identify an instance is openconfig-platformplatform-component-state

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class PlatformComponentState.Type

Field Summary

Fields
Modifier and Type Field Description

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Return description, or `null` if it is not present.
`Boolean`	`getEmpty()`	Return empty, or `null` if it is not present.
`String`	`getFirmwareVersion()`	Return firmwareVersion, or `null` if it is not present.
`String`	`getHardwareVersion()`	Return hardwareVersion, or `null` if it is not present.
`String`	`getId()`	Return id, or `null` if it is not present.
`String`	`getLocation()`	Return location, or `null` if it is not present.
`Date`	`getMfgDate()`	Return mfgDate, or `null` if it is not present.
`String`	`getMfgName()`	Return mfgName, or `null` if it is not present.
`Class<? extends COMPONENTOPERSTATUS>`	`getOperStatus()`	Return operStatus, or `null` if it is not present.
`Object`	`getParent()`	Return parent, or `null` if it is not present.
`String`	`getPartNo()`	Return partNo, or `null` if it is not present.
`Boolean`	`getRemovable()`	Return removable, or `null` if it is not present.
`String`	`getSerialNo()`	Return serialNo, or `null` if it is not present.
`String`	`getSoftwareVersion()`	Return softwareVersion, or `null` if it is not present.
`PlatformComponentState.Type`	`getType()`	Return type, or `null` if it is not present.
`Class<? extends PlatformComponentState>`	`implementedInterface()`
`default @NonNull String`	`requireDescription()`	Return description, guaranteed to be non-null.
`default @NonNull Boolean`	`requireEmpty()`	Return empty, guaranteed to be non-null.
`default @NonNull String`	`requireFirmwareVersion()`	Return firmwareVersion, guaranteed to be non-null.
`default @NonNull String`	`requireHardwareVersion()`	Return hardwareVersion, guaranteed to be non-null.
`default @NonNull String`	`requireId()`	Return id, guaranteed to be non-null.
`default @NonNull String`	`requireLocation()`	Return location, guaranteed to be non-null.
`default @NonNull Date`	`requireMfgDate()`	Return mfgDate, guaranteed to be non-null.
`default @NonNull String`	`requireMfgName()`	Return mfgName, guaranteed to be non-null.
`default @NonNull Class<? extends COMPONENTOPERSTATUS>`	`requireOperStatus()`	Return operStatus, guaranteed to be non-null.
`default @NonNull Object`	`requireParent()`	Return parent, guaranteed to be non-null.
`default @NonNull String`	`requirePartNo()`	Return partNo, guaranteed to be non-null.
`default @NonNull Boolean`	`requireRemovable()`	Return removable, guaranteed to be non-null.
`default @NonNull String`	`requireSerialNo()`	Return serialNo, guaranteed to be non-null.
`default @NonNull String`	`requireSoftwareVersion()`	Return softwareVersion, guaranteed to be non-null.
`default @NonNull PlatformComponentState.Type`	`requireType()`	Return type, guaranteed to be non-null.

Field Detail

QNAME

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

Method Detail

implementedInterface
```
Class<? extends PlatformComponentState> implementedInterface()
```
Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getType

PlatformComponentState.Type getType()

Return type, or null if it is not present.

     
         Type of component as identified by the system

Returns:: Type type, or null if it is not present.

requireType

default @NonNull PlatformComponentState.Type requireType()

Return type, guaranteed to be non-null.

     
         Type of component as identified by the system

Returns:: Type type, guaranteed to be non-null.
Throws:: NoSuchElementException - if type is not present

getId

String getId()

Return id, or null if it is not present.

     
         Unique identifier assigned by the system for the component

Returns:: String id, or null if it is not present.

requireId

default @NonNull String requireId()

Return id, guaranteed to be non-null.

     
         Unique identifier assigned by the system for the component

Returns:: String id, guaranteed to be non-null.
Throws:: NoSuchElementException - if id is not present

getLocation

String getLocation()

Return location, or null if it is not present.

     
         System-supplied description of the location of the component within the system.
         This could be a bay position, slot number, socket location, etc. For component
         types that have an explicit slot-id attribute, such as linecards, the system
         should populate the more specific slot-id.

Returns:: String location, or null if it is not present.

requireLocation

default @NonNull String requireLocation()

Return location, guaranteed to be non-null.

     
         System-supplied description of the location of the component within the system.
         This could be a bay position, slot number, socket location, etc. For component
         types that have an explicit slot-id attribute, such as linecards, the system
         should populate the more specific slot-id.

Returns:: String location, guaranteed to be non-null.
Throws:: NoSuchElementException - if location is not present

getDescription

String getDescription()

Return description, or null if it is not present.

     
         System-supplied description of the component

Returns:: String description, or null if it is not present.

requireDescription
```
default @NonNull String requireDescription()
```
Return description, guaranteed to be non-null.
```
     
         System-supplied description of the component
     
 
```
Returns:

String description, guaranteed to be non-null.

Throws:

NoSuchElementException - if description is not present

getMfgName

String getMfgName()

Return mfgName, or null if it is not present.

     
         System-supplied identifier for the manufacturer of the component. This data is
         particularly useful when a component manufacturer is different than the overall
         device vendor.

Returns:: String mfgName, or null if it is not present.

requireMfgName

default @NonNull String requireMfgName()

Return mfgName, guaranteed to be non-null.

     
         System-supplied identifier for the manufacturer of the component. This data is
         particularly useful when a component manufacturer is different than the overall
         device vendor.

Returns:: String mfgName, guaranteed to be non-null.
Throws:: NoSuchElementException - if mfgName is not present

getMfgDate

Date getMfgDate()

Return mfgDate, or null if it is not present.

     
         System-supplied representation of the component's manufacturing date.

Returns:: Date mfgDate, or null if it is not present.

requireMfgDate
```
default @NonNull Date requireMfgDate()
```
Return mfgDate, guaranteed to be non-null.
```
     
         System-supplied representation of the component's manufacturing date.
     
 
```
Returns:

Date mfgDate, guaranteed to be non-null.

Throws:

NoSuchElementException - if mfgDate is not present

getHardwareVersion

String getHardwareVersion()

Return hardwareVersion, or null if it is not present.

     
         For hardware components, this is the hardware revision of the component.

Returns:: String hardwareVersion, or null if it is not present.

requireHardwareVersion
```
default @NonNull String requireHardwareVersion()
```
Return hardwareVersion, guaranteed to be non-null.
```
     
         For hardware components, this is the hardware revision of the component.
     
 
```
Returns:

String hardwareVersion, guaranteed to be non-null.

Throws:

NoSuchElementException - if hardwareVersion is not present

getFirmwareVersion

String getFirmwareVersion()

Return firmwareVersion, or null if it is not present.

     
         For hardware components, this is the version of associated firmware that is
         running on the component, if applicable.

Returns:: String firmwareVersion, or null if it is not present.

requireFirmwareVersion

default @NonNull String requireFirmwareVersion()

Return firmwareVersion, guaranteed to be non-null.

     
         For hardware components, this is the version of associated firmware that is
         running on the component, if applicable.

Returns:: String firmwareVersion, guaranteed to be non-null.
Throws:: NoSuchElementException - if firmwareVersion is not present

getSoftwareVersion

String getSoftwareVersion()

Return softwareVersion, or null if it is not present.

     
         For software components such as operating system or other software module, this
         is the version of the currently running software.

Returns:: String softwareVersion, or null if it is not present.

requireSoftwareVersion

default @NonNull String requireSoftwareVersion()

Return softwareVersion, guaranteed to be non-null.

     
         For software components such as operating system or other software module, this
         is the version of the currently running software.

Returns:: String softwareVersion, guaranteed to be non-null.
Throws:: NoSuchElementException - if softwareVersion is not present

getSerialNo

String getSerialNo()

Return serialNo, or null if it is not present.

     
         System-assigned serial number of the component.

Returns:: String serialNo, or null if it is not present.

requireSerialNo
```
default @NonNull String requireSerialNo()
```
Return serialNo, guaranteed to be non-null.
```
     
         System-assigned serial number of the component.
     
 
```
Returns:

String serialNo, guaranteed to be non-null.

Throws:

NoSuchElementException - if serialNo is not present

getPartNo

String getPartNo()

Return partNo, or null if it is not present.

     
         System-assigned part number for the component. This should be present in
         particular if the component is also an FRU (field replaceable unit)

Returns:: String partNo, or null if it is not present.

requirePartNo

default @NonNull String requirePartNo()

Return partNo, guaranteed to be non-null.

     
         System-assigned part number for the component. This should be present in
         particular if the component is also an FRU (field replaceable unit)

Returns:: String partNo, guaranteed to be non-null.
Throws:: NoSuchElementException - if partNo is not present

getRemovable

Boolean getRemovable()

Return removable, or null if it is not present.

     
         If true, this component is removable or is a field replaceable unit

Returns:: Boolean removable, or null if it is not present.

requireRemovable
```
default @NonNull Boolean requireRemovable()
```
Return removable, guaranteed to be non-null.
```
     
         If true, this component is removable or is a field replaceable unit
     
 
```
Returns:

Boolean removable, guaranteed to be non-null.

Throws:

NoSuchElementException - if removable is not present

getOperStatus

Class<? extends COMPONENTOPERSTATUS> getOperStatus()

Return operStatus, or null if it is not present.

     
         If applicable, this reports the current operational status of the component.

Returns:: Class<? extends COMPONENTOPERSTATUS> operStatus, or null if it is not present.

requireOperStatus
```
default @NonNull Class<? extends COMPONENTOPERSTATUS> requireOperStatus()
```
Return operStatus, guaranteed to be non-null.
```
     
         If applicable, this reports the current operational status of the component.
     
 
```
Returns:

Class<? extends COMPONENTOPERSTATUS> operStatus, guaranteed to be non-null.

Throws:

NoSuchElementException - if operStatus is not present

getEmpty

Boolean getEmpty()

Return empty, or null if it is not present.

     
         The empty leaf may be used by the device to indicate that a component position
         exists but is not populated. Using this flag, it is possible for the management
         system to learn how many positions are available (e.g., occupied vs. empty
         linecard slots in a chassis).

Returns:: Boolean empty, or null if it is not present.

requireEmpty

default @NonNull Boolean requireEmpty()

Return empty, guaranteed to be non-null.

     
         The empty leaf may be used by the device to indicate that a component position
         exists but is not populated. Using this flag, it is possible for the management
         system to learn how many positions are available (e.g., occupied vs. empty
         linecard slots in a chassis).

Returns:: Boolean empty, guaranteed to be non-null.
Throws:: NoSuchElementException - if empty is not present

getParent

Object getParent()

Return parent, or null if it is not present.

     
         Reference to the name of the parent component. Note that this reference must be
         kept synchronized with the corresponding subcomponent reference from the parent
         component.

Returns:: Object parent, or null if it is not present.

requireParent

default @NonNull Object requireParent()

Return parent, guaranteed to be non-null.

     
         Reference to the name of the parent component. Note that this reference must be
         kept synchronized with the corresponding subcomponent reference from the parent
         component.

Returns:: Object parent, guaranteed to be non-null.
Throws:: NoSuchElementException - if parent is not present

Interface PlatformComponentState

Nested Class Summary

Field Summary