Package jetbrains.buildServer.serverSide.buildLog

Interface BuildLogEx

All Superinterfaces:

BuildLog, BuildLogReader, BuildLogReaderEx, BuildLogWriter, BuildLogWriterEx, FlowHierarchy, MessagesState

All Known Implementing Classes:

NoOpBuildLog, ServerBuildLog

public interface BuildLogEx
extends BuildLog, BuildLogWriterEx, BuildLogReaderEx

Field Summary

Fields inherited from interface jetbrains.buildServer.serverSide.buildLog.MessagesState

MAX_LAST_MESSAGE_TEXT_SIZE

Method Summary

Modifier and Type	Method	Description
void	dispose()
String	getBuildLogId()	The unique id of the build log that allows to find the build log in the storage.
ProgressInfo	getProgressInfo()	Returns progress information for the current build.
boolean	isFlowAwareIndexAvailable()	Returns true if the flow-aware index is available for the build (might trigger index costruction if it is not available yet).
void	refreshNextMessageIndex()	This method exists as a workaround for multi node setup when several nodes can write messages to build log.

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.BuildLog

getMainLogFile, getSizeEstimate, getSizeEstimateAsLong

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.BuildLogReader

getCurrentPath, getDefaultFilteredMessages, getErrorMessages, getFilteredMessages, getLastMessageTimestamp, getMessages, getMessagesIterator, getVerboseIterator, isClosed

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.BuildLogReaderEx

buildLogExists, collectStacktraceTestOutput, collectTestOutput, containsMessageWithHint, createIterator, createIterator, createIterator, createReversedIterator, getAgentTimeZone, getFirstInternalError, getFirstLevelOpenCloseBlocksToIndex, getFlowAwareIndex, getFlowIndex, getFlowStartIndex, getFormatVersion, getHierarchyAndThresholdMessages, getLastIndexSatisfyingKinds, getLowLevelMessagesIterator, getMessageInfo, getNumberOfMessages, getPendingOpenBlocks, getStartedStepsNumber, getVerboseIterator, hasMessagesAvailable, resolveAnchor, resolveAnchors

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.BuildLogWriter

close, flush

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.BuildLogWriterEx

closeBlockAsync, flushIfNeeded, hasLocallyBufferedMessages, scheduleAfterFlushTask

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.FlowHierarchy

flowFinished, flowIdToInt, flowStarted, getFlowWithChildren, getParentFlow

Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.MessagesState

closeBlock, closeBlockAsync, closeProgressBlock, closeProgressBlockAsync, dropProgressText, error, error, getCurrentProgressText, getLastBlockMessage, getLastMessage, message, message, message, messageAsync, messageAsync, openBlock, openBlock, openBlock, openBlockAsync, openBlockAsync, openProgressBlock, openProgressBlock, openProgressBlockAsync, progressMessage, progressMessage, progressMessageAsync

Method Detail

getBuildLogId

@NotNull
String getBuildLogId()

The unique id of the build log that allows to find the build log in the storage. For now this id is the path to the main messages file, but this implementation may be changed at any time.

Since:

2021.1

dispose

void dispose()

refreshNextMessageIndex

void refreshNextMessageIndex()

This method exists as a workaround for multi node setup when several nodes can write messages to build log. In this case index of the next message can become obsolete and if this index is required, then this refresh method should be called before logging a message to the build log.

Since:

2019.1

isFlowAwareIndexAvailable

boolean isFlowAwareIndexAvailable()

Returns true if the flow-aware index is available for the build (might trigger index costruction if it is not available yet).

Since:

2022.1

getProgressInfo

@NotNull
ProgressInfo getProgressInfo()

Returns progress information for the current build.

Since:

2023.11