LogCopier.Builder (gobblin-utility 0.11.0 API)

java.lang.Object
- gobblin.util.logs.LogCopier.Builder

Enclosing class:: LogCopier

public static class LogCopier.Builder
extends Object

A builder class for LogCopier.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogCopier.Builder`	`acceptsLogFileExtensions(Set<String> logFileExtensions)` Set the set of acceptable log file extensions.
`LogCopier`	`build()` Build a new `LogCopier` instance.
`LogCopier.Builder`	`readFrom(Path srcLogDir)` Set the path of the source log file directory to read from.
`LogCopier.Builder`	`useCopyInterval(long copyInterval)` Set the copy interval between two iterations of copies.
`LogCopier.Builder`	`useDestFileSystem(FileSystem destFs)` Set the destination `FileSystem` for writing the destination log file.
`LogCopier.Builder`	`useExcludingRegexPatterns(String regexList)` Set the regex patterns used to filter logs that should not be copied.
`LogCopier.Builder`	`useIncludingRegexPatterns(String regexList)` Set the regex patterns used to filter logs that should be copied.
`LogCopier.Builder`	`useLinesWrittenBeforeFlush(int linesWrittenBeforeFlush)` Set the number of lines written before they are flushed to disk.
`LogCopier.Builder`	`useLogFileNamePrefix(String logFileNamePrefix)` Set the log file name prefix at the destination.
`LogCopier.Builder`	`useMaxBytesPerLogFile(long maxBytesPerLogFile)` Set the max bytes per log file.
`LogCopier.Builder`	`useMaxMinutesPerLogFile(long maxMinutesPerLogFile)` Set the max minutes per log file.
`LogCopier.Builder`	`useScheduler(String schedulerName)` Set the scheduler to use for scheduling copy tasks.
`LogCopier.Builder`	`useSourceLogFileMonitorInterval(long sourceLogFileMonitorInterval)` Set the interval between two checks for the source log file monitor.
`LogCopier.Builder`	`useSrcFileSystem(FileSystem srcFs)` Set the source `FileSystem` for reading the source log file.
`LogCopier.Builder`	`useTimeUnit(TimeUnit timeUnit)` Set the `TimeUnit` used for the source log file monitor interval, initial delay, copy interval.
`LogCopier.Builder`	`writeTo(Path destLogDir)` Set the path of the destination log file directory to write to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - useSourceLogFileMonitorInterval
```
public LogCopier.Builder useSourceLogFileMonitorInterval(long sourceLogFileMonitorInterval)
```
    Set the interval between two checks for the source log file monitor.
    
    Parameters:
    
    sourceLogFileMonitorInterval - the interval between two checks for the source log file monitor
    
    Returns:
    
    this LogCopier.Builder instance
  - useCopyInterval
```
public LogCopier.Builder useCopyInterval(long copyInterval)
```
    Set the copy interval between two iterations of copies.
    
    Parameters:
    
    copyInterval - the copy interval between two iterations of copies
    
    Returns:
    
    this LogCopier.Builder instance
  - useMaxMinutesPerLogFile
```
public LogCopier.Builder useMaxMinutesPerLogFile(long maxMinutesPerLogFile)
```
    Set the max minutes per log file.
    
    Parameters:
    
    maxMinutesPerLogFile - the maximum minutes of logs a log file contains
    
    Returns:
    
    this LogCopier.Builder instance
  - useMaxBytesPerLogFile
```
public LogCopier.Builder useMaxBytesPerLogFile(long maxBytesPerLogFile)
```
    Set the max bytes per log file.
    
    Parameters:
    
    maxBytesPerLogFile - the maximum bytes of a log file
    
    Returns:
    
    this LogCopier.Builder instance
  - useTimeUnit
```
public LogCopier.Builder useTimeUnit(TimeUnit timeUnit)
```
    Set the TimeUnit used for the source log file monitor interval, initial delay, copy interval.
    
    Parameters:
    
    timeUnit - the TimeUnit used for the initial delay and copy interval
    
    Returns:
    
    this LogCopier.Builder instance
  - acceptsLogFileExtensions
```
public LogCopier.Builder acceptsLogFileExtensions(Set<String> logFileExtensions)
```
    Set the set of acceptable log file extensions.
    
    Parameters:
    
    logFileExtensions - the set of acceptable log file extensions
    
    Returns:
    
    this LogCopier.Builder instance
  - useIncludingRegexPatterns
```
public LogCopier.Builder useIncludingRegexPatterns(String regexList)
```
    Set the regex patterns used to filter logs that should be copied.
    
    Parameters:
    
    regexList - a comma-separated list of regex patterns
    
    Returns:
    
    this LogCopier.Builder instance
  - useExcludingRegexPatterns
```
public LogCopier.Builder useExcludingRegexPatterns(String regexList)
```
    Set the regex patterns used to filter logs that should not be copied.
    
    Parameters:
    
    regexList - a comma-separated list of regex patterns
    
    Returns:
    
    this LogCopier.Builder instance
  - useSrcFileSystem
```
public LogCopier.Builder useSrcFileSystem(FileSystem srcFs)
```
    Set the source FileSystem for reading the source log file.
    
    Parameters:
    
    srcFs - the source FileSystem for reading the source log file
    
    Returns:
    
    this LogCopier.Builder instance
  - useDestFileSystem
```
public LogCopier.Builder useDestFileSystem(FileSystem destFs)
```
    Set the destination FileSystem for writing the destination log file.
    
    Parameters:
    
    destFs - the destination FileSystem for writing the destination log file
    
    Returns:
    
    this LogCopier.Builder instance
  - readFrom
```
public LogCopier.Builder readFrom(Path srcLogDir)
```
    Set the path of the source log file directory to read from.
    
    Parameters:
    
    srcLogDir - the path of the source log file directory to read from
    
    Returns:
    
    this LogCopier.Builder instance
  - writeTo
```
public LogCopier.Builder writeTo(Path destLogDir)
```
    Set the path of the destination log file directory to write to.
    
    Parameters:
    
    destLogDir - the path of the destination log file directory to write to
    
    Returns:
    
    this LogCopier.Builder instance
  - useLogFileNamePrefix
```
public LogCopier.Builder useLogFileNamePrefix(String logFileNamePrefix)
```
    Set the log file name prefix at the destination.
    
    Parameters:
    
    logFileNamePrefix - the log file name prefix at the destination
    
    Returns:
    
    this LogCopier.Builder instance
  - useLinesWrittenBeforeFlush
```
public LogCopier.Builder useLinesWrittenBeforeFlush(int linesWrittenBeforeFlush)
```
    Set the number of lines written before they are flushed to disk.
    
    Parameters:
    
    linesWrittenBeforeFlush - the number of lines written before they are flushed to disk
    
    Returns:
    
    this LogCopier.Builder instance
  - useScheduler
```
public LogCopier.Builder useScheduler(String schedulerName)
```
    Set the scheduler to use for scheduling copy tasks.
    
    Parameters:
    
    schedulerName - the name of the scheduler
    
    Returns:
    
    this LogCopier.Builder instance
  - build
```
public LogCopier build()
```
    Build a new LogCopier instance.
    
    Returns:
    
    a new LogCopier instance

Class LogCopier.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

useSourceLogFileMonitorInterval

useCopyInterval

useMaxMinutesPerLogFile

useMaxBytesPerLogFile

useTimeUnit

acceptsLogFileExtensions

useIncludingRegexPatterns

useExcludingRegexPatterns

useSrcFileSystem

useDestFileSystem

readFrom

writeTo

useLogFileNamePrefix

useLinesWrittenBeforeFlush

useScheduler

build