DockerLogsContainer (gradle-docker-plugin 6.7.0 API)

com.bmuschko.gradle.docker.tasks.container.DockerLogsContainer

Copies the container logs into standard out/err, the same as the `docker logs` command. The container output to standard out will go to standard out, and standard err to standard err.

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Property<Boolean>`	`follow` Set to true to follow the output, which will cause this task to block until the container exists.
`Property<Boolean>`	`showTimestamps` Set to the true to include a timestamp for each line in the output.
`Property<Date>`	`since` Limit the output to lines on or after the specified date.
`Writer`	`sink` Sink to write log output into.
`Property<Boolean>`	`stdErr` Include standard err.
`Property<Boolean>`	`stdOut` Include standard out.
`Property<Boolean>`	`tailAll` Set to true to copy all output since the container has started.
`Property<Integer>`	`tailCount` Limit the number of lines of existing output.

Constructor Summary

Constructors
Constructor and description
`DockerLogsContainer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected Date`	`getInternalSince()`
	`void`	`logAndProcessResponse(com.github.dockerjava.api.DockerClient dockerClient)`
	`void`	`runRemoteCommand()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DockerExistingContainer`	`targetContainerId, targetContainerId, targetContainerId`
`class AbstractDockerRemoteApiTask`	`getDockerClient, getNextHandler, getRegistryAuthLocator, onComplete, onError, onNext, runRemoteCommand, start`
`class DefaultTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - @Input @Optional final Property<Boolean> follow
    
    Set to true to follow the output, which will cause this task to block until the container exists. Default is unspecified (docker defaults to false).
  - @Input @Optional final Property<Boolean> showTimestamps
    
    Set to the true to include a timestamp for each line in the output. Default is unspecified (docker defaults to false).
  - @Input @Optional final Property<Date> since
    
    Limit the output to lines on or after the specified date. Default is unspecified (docker defaults to all lines).
  - @Input @Optional Writer sink
    
    Sink to write log output into.
  - @Input @Optional final Property<Boolean> stdErr
    
    Include standard err. Default is true.
  - @Input @Optional final Property<Boolean> stdOut
    
    Include standard out. Default is true.
  - @Input @Optional final Property<Boolean> tailAll
    
    Set to true to copy all output since the container has started. For long running containers or containers with a lot of output this could take a long time. This cannot be set if #tailCount is also set. Setting to false leaves the decision of how many lines to copy to docker. Default is unspecified (docker defaults to true).
  - @Input @Optional final Property<Integer> tailCount
    
    Limit the number of lines of existing output. This cannot be set if #tailAll is also set. Default is unspecified (docker defaults to all lines).
- Constructor Detail
  - DockerLogsContainer()
- Method Detail
  - @Internal protected Date getInternalSince()
  - void logAndProcessResponse(com.github.dockerjava.api.DockerClient dockerClient)
  - @Override void runRemoteCommand()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class DockerLogsContainer

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Input @Optional final Property<Boolean> follow

@Input @Optional final Property<Boolean> showTimestamps

@Input @Optional final Property<Date> since

@Input @Optional Writer sink

@Input @Optional final Property<Boolean> stdErr

@Input @Optional final Property<Boolean> stdOut

@Input @Optional final Property<Boolean> tailAll

@Input @Optional final Property<Integer> tailCount

Constructor Detail

DockerLogsContainer()

Method Detail

@Internal protected Date getInternalSince()

void logAndProcessResponse(com.github.dockerjava.api.DockerClient dockerClient)

@Override void runRemoteCommand()