Class RecordingInfo
java.lang.Object
jdk.management.jfr.RecordingInfo
Management representation of a
Recording.- Since:
- 9
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic RecordingInfofrom(CompositeData cd) Returns aRecordingInforepresented by the specifiedCompositeDataobject.Returns destination path where data, for the recording associated with thisRecordingInfo, should be written when the recording stops, ornullif the recording should not be written.booleanReturns if the recording associated with thisRecordingInfoshould be dumped to file when the JVM exits.longReturns the desired duration, measured in seconds, of the recording associated with thisRecordingInfo, or0if no duration has been set.longgetId()Returns the unique ID for the recording associated with thisRecordingInfo.longReturns how many seconds data should be kept on disk, or0if data is to be kept forever.longReturns the amount of data, measured in bytes, the recording associated with thisRecordingInfo, should be kept on disk, before it's rotated away, or0if data is to be kept indefinitely.getName()Returns the name of the recording associated with thisRecordingInfo.Returns the settings for the recording associated with thisRecordingInfo.longgetSize()Returns the amount data recorded by recording. associated with thisRecordingInfo.longReturns start time of the recording associated with thisRecordingInfo, measured as ms since epoch, ornullif the recording hasn't started.getState()Returns aStringrepresentation of state of the recording associated with thisRecordingInfo.longReturns the actual or expected stop time of the recording associated with thisRecordingInfo, measured as ms since epoch, ornullif the expected or actual stop time is not known, which can only happen if the recording has not yet been stopped.booleanisToDisk()Returnstrueif the recording associated with thisRecordingInfoshould be flushed to disk, when memory buffers are full,falseotherwise.toString()Returns a string description of the recording associated with thisRecordingInfo
-
Method Details
-
getName
Returns the name of the recording associated with thisRecordingInfo.- Returns:
- the recording name, not
null - See Also:
-
getId
public long getId()Returns the unique ID for the recording associated with thisRecordingInfo.- Returns:
- the recording ID
- See Also:
-
getDumpOnExit
public boolean getDumpOnExit()Returns if the recording associated with thisRecordingInfoshould be dumped to file when the JVM exits.- Returns:
trueif recording should be dumped on exit,falseotherwise- See Also:
-
getMaxAge
public long getMaxAge()Returns how many seconds data should be kept on disk, or0if data is to be kept forever.In-memory recordings are not affected by maximum age.
- Returns:
- how long data should be kept on disk, measured in seconds
- See Also:
-
getMaxSize
public long getMaxSize()Returns the amount of data, measured in bytes, the recording associated with thisRecordingInfo, should be kept on disk, before it's rotated away, or0if data is to be kept indefinitely.In-memory recordings are not affected by maximum size.
- Returns:
- the amount of data should be kept on disk, in bytes
- See Also:
-
getState
Returns aStringrepresentation of state of the recording associated with thisRecordingInfo.Valid return values are
"NEW","DELAYED","STARTING","RUNNING","STOPPING","STOPPED"and"CLOSED".- Returns:
- the recording state, not
null - See Also:
-
getStartTime
public long getStartTime()Returns start time of the recording associated with thisRecordingInfo, measured as ms since epoch, ornullif the recording hasn't started.- Returns:
- the start time of the recording, or
nullif the recording hasn't started - See Also:
-
getStopTime
public long getStopTime()Returns the actual or expected stop time of the recording associated with thisRecordingInfo, measured as ms since epoch, ornullif the expected or actual stop time is not known, which can only happen if the recording has not yet been stopped.- Returns:
- the stop time of recording, or
nullif recording hasn't been stopped. - See Also:
-
getSettings
-
getDestination
Returns destination path where data, for the recording associated with thisRecordingInfo, should be written when the recording stops, ornullif the recording should not be written.- Returns:
- the destination, or
nullif not set - See Also:
-
toString
-
getSize
public long getSize()Returns the amount data recorded by recording. associated with thisRecordingInfo.- Returns:
- the amount of recorded data, measured in bytes
-
isToDisk
public boolean isToDisk()Returnstrueif the recording associated with thisRecordingInfoshould be flushed to disk, when memory buffers are full,falseotherwise.- Returns:
trueif recording is to disk,falseotherwise
-
getDuration
public long getDuration()Returns the desired duration, measured in seconds, of the recording associated with thisRecordingInfo, or0if no duration has been set.- Returns:
- the desired duration, or
0if no duration has been set - See Also:
-
from
Returns aRecordingInforepresented by the specifiedCompositeDataobject.The specified
CompositeDatamust have the following item names and item types to be valid.Supported names and types in a specified CompositeDataobjectName Type id Longname Stringstate StringdumpOnExit Booleansize LongtoDisk BooleanmaxAge LongmaxSize LongstartTime LongstopTime Longdestination Stringduration Longsettings javax.management.openmbean.CompositeData[]whose element type is the mapped type forSettingDescriptorInfoas specified in theSettingDescriptorInfo.from(javax.management.openmbean.CompositeData)method.- Parameters:
cd-CompositeDatarepresenting theRecordingInfoto return- Returns:
- the
RecordingInforepresented bycd, ornullifcdisnull - Throws:
IllegalArgumentException- ifcddoes not represent a validRecordingInfo
-