Класс RecordingInfo

java.lang.Object

jdk.management.jfr.RecordingInfo

public final class RecordingInfo extends Object

Представление управления Recording.

Since:

См. также:

Краткое описание методов

Модификатор и тип	Метод	Описание
`static RecordingInfo`	`from(CompositeData cd)`	Возвращает `RecordingInfo`, представленный указанным объектом `CompositeData`.
`String`	`getDestination()`	Возвращает путь к целевому файлу, куда должны быть записаны данные для записи, связанной с этим `RecordingInfo`, при остановке записи, или `null`, если запись не должна быть сохранена.
`boolean`	`getDumpOnExit()`	Возвращает, следует ли выгрузить запись, связанную с этим `RecordingInfo`, в файл при завершении JVM.
`long`	`getDuration()`	Возвращает желаемую продолжительность записи, измеренную в секундах, связанной с этим `RecordingInfo`, или `0`, если продолжительность не задана.
`long`	`getId()`	Возвращает уникальный идентификатор записи, связанной с этим `RecordingInfo`.
`long`	`getMaxAge()`	Возвращает количество секунд, в течение которых данные должны храниться на диске, или `0`, если данные должны храниться постоянно.
`long`	`getMaxSize()`	Возвращает объем данных, измеренный в байтах, который запись, связанная с этим `RecordingInfo`, должна хранить на диске, прежде чем она будет пересохранена, или `0`, если данные должны храниться неограниченно.
`String`	`getName()`	Возвращает имя записи, связанной с этим `RecordingInfo`.
`Map<String,String>`	`getSettings()`	Возвращает настройки записи, связанной с этим `RecordingInfo`.
`long`	`getSize()`	Возвращает количество данных, записанных записью. связанной с этим `RecordingInfo`.
`long`	`getStartTime()`	Возвращает начальное время записи, связанной с этим `RecordingInfo`, измеренное в мс с эпохи, или `null`, если запись еще не началась.
`String`	`getState()`	Возвращает представление `String` состояния записи, связанной с этим `RecordingInfo`.
`long`	`getStopTime()`	Возвращает фактическое или ожидаемое время остановки записи, связанной с этим `RecordingInfo`, измеренное в мс с эпохи, или `null`, если ожидаемое или фактическое время остановки неизвестно, что может произойти только в том случае, если запись еще не остановлена.
`boolean`	`isToDisk()`	Возвращает `true`, если запись, связанная с этим `RecordingInfo`, должна быть записана на диск, когда буферы памяти полны, `false`, в противном случае.
`String`	`toString()`	Возвращает строковое описание записи, связанной с этим `RecordingInfo`

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание методов

getName

public String getName()

Возвращает имя записи, связанной с этим RecordingInfo.

Возвращает:

имя записи, не null.

См. также:

getId

public long getId()

Возвращает уникальный идентификатор записи, связанной с этим RecordingInfo.

Возвращает:

идентификатор записи

См. также:

getDumpOnExit

public boolean getDumpOnExit()

Возвращает, должна ли запись, связанная с этим RecordingInfo, быть сохранена в файл при выходе JVM.

Возвращает:

true если запись должна быть сохранена при выходе, false в противном случае

См. также:

getMaxAge

public long getMaxAge()

Возвращает количество секунд, в течение которых данные должны храниться на диске, или 0 если данные должны храниться постоянно.

Записи в оперативной памяти не затрагиваются максимальным сроком хранения.

Возвращает:

сколько времени данные должны храниться на диске, измеряется в секундах

См. также:

getMaxSize

public long getMaxSize()

Возвращает объем данных, измеренный в байтах, который запись, связанная с этим RecordingInfo, должна хранить на диске, прежде чем она будет перезаписана, или 0 если данные должны храниться неограниченно.

Записи в оперативной памяти не затрагиваются максимальным размером.

Возвращает:

объем данных, который следует хранить на диске, в байтах

См. также:

getState

public String getState()

Возвращает строковое представление состояния записи, связанной с этим RecordingInfo.

Допустимые значения возврата: "NEW", "DELAYED", "STARTING", "RUNNING", "STOPPING", "STOPPED" и "CLOSED".

Возвращает:

состояние записи, не null.

См. также:

getStartTime

public long getStartTime()

Возвращает время начала записи, связанной с этим RecordingInfo, измеренное в мс с момента эпохи, или null если запись еще не началась.

Возвращает:

время начала записи, или null если запись еще не началась

См. также:

getStopTime

public long getStopTime()

Возвращает фактическое или ожидаемое время остановки записи, связанной с этим RecordingInfo, измеренное в мс с момента эпохи, или null если ожидаемое или фактическое время остановки неизвестно, что возможно только в том случае, если запись еще не остановлена.

Возвращает:

время остановки записи, или null если запись еще не остановлена.

См. также:

getSettings

public Map<String,String> getSettings()

Возвращает параметры записи, связанные с этим RecordingInfo.

Возвращает:

параметры записи, не null.

См. также:

getDestination

public String getDestination()

Возвращает путь к каталогу, в который должны быть записаны данные для записи, связанной с этим RecordingInfo, при остановке записи, или null если запись не должна быть записана.

Возвращает:

путь к каталогу, или null если не задан

См. также:

toString

public String toString()

Возвращает строковое описание записи, связанной с этим RecordingInfo

Overrides:: toString в классе Object
Возвращает:: описание, не null

getSize

public long getSize()

Возвращает объем записанных данных записью, связанной с этим RecordingInfo.

Возвращает:: объем записанных данных, измеренный в байтах

isToDisk

public boolean isToDisk()

Возвращает true если запись, связанная с этим RecordingInfo, должна быть сохранена на диск, когда буферы памяти заполнены, false в противном случае.

Возвращает:: true если запись на диске, false в противном случае

getDuration

public long getDuration()

Возвращает желаемую длительность, измеряемую в секундах, записи, связанной с этим RecordingInfo, или 0 если длительность не задана.

Возвращает:

желаемая длительность, или 0 если длительность не задана

См. также:

from

public static RecordingInfo from(CompositeData cd)

Возвращает запись, представленную указанным объектом CompositeData.

Указанный объект CompositeData должен иметь следующие имена элементов и типы элементов для правильной работы.

Поддерживаемые имена и типы в указанном объекте CompositeData

Имя Тип

id Long

name String

state String

dumpOnExit Boolean

size Long

toDisk Boolean

maxAge Long

maxSize Long

startTime Long

stopTime Long

destination String

duration Long

settings javax.management.openmbean.CompositeData[] содержащий элементы типа, сопоставленного с SettingDescriptorInfo, как указано в методе SettingDescriptorInfo.from(javax.management.openmbean.CompositeData).

Поддерживаемые имена и типы в указанном объекте `CompositeData`
Имя	Тип
id	`Long`
name	`String`
state	`String`
dumpOnExit	`Boolean`
size	`Long`
toDisk	`Boolean`
maxAge	`Long`
maxSize	`Long`
startTime	`Long`
stopTime	`Long`
destination	`String`
duration	`Long`
settings	`javax.management.openmbean.CompositeData[]` содержащий элементы типа, сопоставленного с `SettingDescriptorInfo`, как указано в методе `SettingDescriptorInfo.from(javax.management.openmbean.CompositeData)`.

Параметры:: cd - CompositeData представляющий запись для возврата
Возвращает:: запись, представленную cd, или null если cd равно null
Исключения:: IllegalArgumentException - если cd не представляет собой действительную запись RecordingInfo

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management.jfr/jdk/management/jfr/RecordingInfo.html