DockerContainerLogsSettings Class

Summary

Settings for docker logs [OPTIONS] CONTAINER. Fetch the logs of a container
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerContainerLogsSettings"] class Type type-node

Syntax

public sealed class DockerContainerLogsSettings : AutoToolSettings

Constructors

Fields

Name Constant Value Summary
SecretProperties
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings

Properties

Name Value Summary
Details Nullable<bool>
--details default: false Show extra details provided to logs
Follow Nullable<bool>
--follow, -f default: false Follow log output
Since string
--since Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
Tail string
--tail default: all Number of lines to show from the end of the logs
Timestamps Nullable<bool>
--timestamps, -t default: false Show timestamps
Until string
--until Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)

Methods

Name Value Summary
CollectSecretProperties() string[]
Collects secret properties.
Inherited from AutoToolSettings

Extension Methods

Name Value Summary
Dump<DockerContainerLogsSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DockerContainerLogsSettings>(DockerContainerLogsSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DockerContainerLogsSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DockerContainerLogsSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DockerContainerLogsSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DockerContainerLogsSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin