This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Docker.

Summary

Settings for docker buildx create.

Assembly

Cake.Docker.dll

Namespace

Cake.Docker

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerBuildXCreateSettings"] class Type type-node

Syntax

public sealed class DockerBuildXCreateSettings : AutoToolSettings

Constructors

Name	Summary
DockerBuildXCreateSettings()

Fields

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

Properties

Name	Value	Summary
Append	bool	Append a node to builder instead of changing it
Bootstrap	bool	Boot builder after creation
Builder	string	Override the configured builder instance
BuildkitdFlags	string	Flags for buildkitd daemon
Config	string	BuildKit config file
Driver	string	Driver to use (available: "docker", "docker-container", "kubernetes")
DriverOpt	string[]	Options for the driver
Leave	bool	Remove a node from builder instead of changing it
Name	string	Builder instance name
Node	string	Create/modify node with given name
Platform	string[]	Fixed platforms for current node
Use	bool	Set the current builder instance

Methods

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

Extension Methods

Name	Value	Summary
Dump<DockerBuildXCreateSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DockerBuildXCreateSettings>(DockerBuildXCreateSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DockerBuildXCreateSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DockerBuildXCreateSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<DockerBuildXCreateSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<DockerBuildXCreateSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin