BuildLog (javadoc 2024.12-174331 API)

All Superinterfaces:

BuildLogReader, BuildLogWriter, FlowHierarchy, MessagesState

All Known Subinterfaces:

BuildLogEx

All Known Implementing Classes:

NoOpBuildLog, ServerBuildLog
```
public interface BuildLog
extends BuildLogReader, BuildLogWriter, FlowHierarchy
```
Allows writing and reading build 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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`File`	`getMainLogFile()`	Deprecated. since 2021.1 and should not be used anymore
`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.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
  - getSizeEstimate
```
@NotNull
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
```
@Deprecated
@NotNull
File getMainLogFile()
```
    Deprecated.
    since 2021.1 and should not be used anymore
    
    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 may have one or more index files, stored nearby this messages log file.
    
    Since:
    
    9.0