jetbrains.buildServer.serverSide.buildLog
Interface BuildLog

All Superinterfaces:
BuildLogReader, BuildLogWriter, FlowHierarchy, MessagesState

public interface BuildLog
extends BuildLogReader, BuildLogWriter, FlowHierarchy

BuildLog allows to write and read log messages. Messages can be written until BuildLogWriter.close() method is invoked. Usually this happens when build is finishing. Messages can be read at any time.


Field Summary
 
Fields inherited from interface jetbrains.buildServer.serverSide.buildLog.MessagesState
MAX_LAST_MESSAGE_TEXT_SIZE
 
Method Summary
 java.io.File getMainLogFile()
          Primary log file which contains messages of the log.
 java.lang.String getSizeEstimate()
          Returns a human-readable string containing approx.
 long getSizeEstimateAsLong()
          Returns an approx.
 
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.BuildLogWriter
close, flush
 
Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.MessagesState
closeBlock, closeProgressBlock, dropProgressText, error, error, getCurrentProgressText, getLastBlockMessage, getLastMessage, message, message, message, openBlock, openBlock, openBlock, openProgressBlock, openProgressBlock, progressMessage, progressMessage
 
Methods inherited from interface jetbrains.buildServer.serverSide.buildLog.FlowHierarchy
flowFinished, flowIdToInt, flowStarted, getFlowWithChildren, getParentFlow
 

Method Detail

getSizeEstimate

java.lang.String getSizeEstimate()
Returns a human-readable string containing approx. build log size.

Returns:
approx. build log size as string

getSizeEstimateAsLong

long getSizeEstimateAsLong()
Returns an approx. build log size.

Returns:
approx. build log size as long
Since:
5.0

getMainLogFile

java.io.File getMainLogFile()
Primary log file which contains messages of the log. This file MUST NOT be used to read or write messages, but only as a reference on where the log is stored. The build log also has may have an index file, stored nearby this messages log file.

Returns:
see above
Since:
9.0