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 ProcmonProcessAttributesState
extends org.opendaylight.yangtools.yang.binding.DataObject

Attributes state definitions for a process

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

 grouping procmon-process-attributes-state {
   leaf pid {
     type uint64;
   }
   leaf name {
     type string;
   }
   leaf-list args {
     type string;
   }
   leaf start-time {
     type oc-types:timeticks64;
   }
   leaf cpu-usage-user {
     type oc-yang:counter64;
     units nanoseconds;
   }
   leaf cpu-usage-system {
     type oc-yang:counter64;
     units nanoseconds;
   }
   leaf cpu-utilization {
     type oc-types:percentage;
   }
   leaf memory-usage {
     type uint64;
     units bytes;
   }
   leaf memory-utilization {
     type oc-types:percentage;
   }
 }

The schema path to identify an instance is openconfig-procmonprocmon-process-attributes-state

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
`@Nullable List<String>`	`getArgs()`	Return args, or `null` if it is not present.
`Counter64`	`getCpuUsageSystem()`	Return cpuUsageSystem, or `null` if it is not present.
`Counter64`	`getCpuUsageUser()`	Return cpuUsageUser, or `null` if it is not present.
`Percentage`	`getCpuUtilization()`	Return cpuUtilization, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint64`	`getMemoryUsage()`	Return memoryUsage, or `null` if it is not present.
`Percentage`	`getMemoryUtilization()`	Return memoryUtilization, or `null` if it is not present.
`String`	`getName()`	Return name, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint64`	`getPid()`	Return pid, or `null` if it is not present.
`Timeticks64`	`getStartTime()`	Return startTime, or `null` if it is not present.
`Class<? extends ProcmonProcessAttributesState>`	`implementedInterface()`
`default @NonNull List<String>`	`requireArgs()`	Return args, guaranteed to be non-null.
`default @NonNull Counter64`	`requireCpuUsageSystem()`	Return cpuUsageSystem, guaranteed to be non-null.
`default @NonNull Counter64`	`requireCpuUsageUser()`	Return cpuUsageUser, guaranteed to be non-null.
`default @NonNull Percentage`	`requireCpuUtilization()`	Return cpuUtilization, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint64`	`requireMemoryUsage()`	Return memoryUsage, guaranteed to be non-null.
`default @NonNull Percentage`	`requireMemoryUtilization()`	Return memoryUtilization, guaranteed to be non-null.
`default @NonNull String`	`requireName()`	Return name, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint64`	`requirePid()`	Return pid, guaranteed to be non-null.
`default @NonNull Timeticks64`	`requireStartTime()`	Return startTime, guaranteed to be non-null.

Field Detail

QNAME

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

Method Detail

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

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

Specified by:

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

getPid

org.opendaylight.yangtools.yang.common.Uint64 getPid()

Return pid, or null if it is not present.

     
         The process pid

Returns:: Uint64 pid, or null if it is not present.

requirePid
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requirePid()
```
Return pid, guaranteed to be non-null.
```
     
         The process pid
     
 
```
Returns:

Uint64 pid, guaranteed to be non-null.

Throws:

NoSuchElementException - if pid is not present

getName
```
String getName()
```
Return name, or null if it is not present.
```
     
         The process name
     
 
```
Returns:

String name, or null if it is not present.

requireName
```
default @NonNull String requireName()
```
Return name, guaranteed to be non-null.
```
     
         The process name
     
 
```
Returns:

String name, guaranteed to be non-null.

Throws:

NoSuchElementException - if name is not present

getArgs

@Nullable List<String> getArgs()

Return args, or null if it is not present.

     
         Current process command line arguments. Arguments with a parameter (e.g.,
         --option 10 or -option=10) should be represented as a single element of the list
         with the argument name and parameter together. Flag arguments, i.e., those
         without a parameter should also be in their own list element.

Returns:: List<String> args, or null if it is not present.

requireArgs

default @NonNull List<String> requireArgs()

Return args, guaranteed to be non-null.

     
         Current process command line arguments. Arguments with a parameter (e.g.,
         --option 10 or -option=10) should be represented as a single element of the list
         with the argument name and parameter together. Flag arguments, i.e., those
         without a parameter should also be in their own list element.

Returns:: List<String> args, guaranteed to be non-null.
Throws:: NoSuchElementException - if args is not present

getStartTime

Timeticks64 getStartTime()

Return startTime, or null if it is not present.

     
         The time at which this process started, relative to the UNIX epoch. The system
         must be synchronized such that the start-time can be reported accurately,
         otherwise it should not be reported.

Returns:: Timeticks64 startTime, or null if it is not present.

requireStartTime

default @NonNull Timeticks64 requireStartTime()

Return startTime, guaranteed to be non-null.

     
         The time at which this process started, relative to the UNIX epoch. The system
         must be synchronized such that the start-time can be reported accurately,
         otherwise it should not be reported.

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

getCpuUsageUser

Counter64 getCpuUsageUser()

Return cpuUsageUser, or null if it is not present.

     
         CPU time consumed by this process in user mode in nanoseconds.

Returns:: Counter64 cpuUsageUser, or null if it is not present.

requireCpuUsageUser
```
default @NonNull Counter64 requireCpuUsageUser()
```
Return cpuUsageUser, guaranteed to be non-null.
```
     
         CPU time consumed by this process in user mode in nanoseconds.
     
 
```
Returns:

Counter64 cpuUsageUser, guaranteed to be non-null.

Throws:

NoSuchElementException - if cpuUsageUser is not present

getCpuUsageSystem

Counter64 getCpuUsageSystem()

Return cpuUsageSystem, or null if it is not present.

     
         CPU time consumed by this process in kernel mode.

Returns:: Counter64 cpuUsageSystem, or null if it is not present.

requireCpuUsageSystem
```
default @NonNull Counter64 requireCpuUsageSystem()
```
Return cpuUsageSystem, guaranteed to be non-null.
```
     
         CPU time consumed by this process in kernel mode.
     
 
```
Returns:

Counter64 cpuUsageSystem, guaranteed to be non-null.

Throws:

NoSuchElementException - if cpuUsageSystem is not present

getCpuUtilization

Percentage getCpuUtilization()

Return cpuUtilization, or null if it is not present.

     
         The percentage of CPU that is being used by the process.

Returns:: Percentage cpuUtilization, or null if it is not present.

requireCpuUtilization
```
default @NonNull Percentage requireCpuUtilization()
```
Return cpuUtilization, guaranteed to be non-null.
```
     
         The percentage of CPU that is being used by the process.
     
 
```
Returns:

Percentage cpuUtilization, guaranteed to be non-null.

Throws:

NoSuchElementException - if cpuUtilization is not present

getMemoryUsage

org.opendaylight.yangtools.yang.common.Uint64 getMemoryUsage()

Return memoryUsage, or null if it is not present.

     
         Bytes allocated and still in use by the process

Returns:: Uint64 memoryUsage, or null if it is not present.

requireMemoryUsage

default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireMemoryUsage()

Return memoryUsage, guaranteed to be non-null.

     
         Bytes allocated and still in use by the process

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

getMemoryUtilization

Percentage getMemoryUtilization()

Return memoryUtilization, or null if it is not present.

     
         The percentage of RAM that is being used by the process.

Returns:: Percentage memoryUtilization, or null if it is not present.

requireMemoryUtilization
```
default @NonNull Percentage requireMemoryUtilization()
```
Return memoryUtilization, guaranteed to be non-null.
```
     
         The percentage of RAM that is being used by the process.
     
 
```
Returns:

Percentage memoryUtilization, guaranteed to be non-null.

Throws:

NoSuchElementException - if memoryUtilization is not present

Interface ProcmonProcessAttributesState

Field Summary

Method Summary

Field Detail

QNAME

Method Detail

implementedInterface

getPid

requirePid

getName

requireName