BuildahConfigOptions.Generated.cs

// <auto-generated>
// This file was generated by ModularPipelines.OptionsGenerator.
// Do not edit this file manually.
// </auto-generated>

#nullable enable

using System.CodeDom.Compiler;
using System.Diagnostics.CodeAnalysis;
using ModularPipelines.Attributes;
using ModularPipelines.Buildah.Options;

namespace ModularPipelines.Buildah.Options;

/// <summary>
/// Modifies the configuration values which will be saved to the image.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
[ExcludeFromCodeCoverage]
[CliSubCommand("config")]
public record BuildahConfigOptions : BuildahOptions
{
    /// <summary>
    /// add an entry for this operation to the image's history.  Use BUILDAH_HISTORY environment variable to override. (default false)
    /// </summary>
    [CliFlag("--add-history")]
    public bool? AddHistory { get; set; }

    /// <summary>
    /// add annotation e.g. annotation=value, for the target image (default [])
    /// </summary>
    [CliOption("--annotation", ShortForm = "-a", Format = OptionFormat.EqualsSeparated)]
    public string? Annotation { get; set; }

    /// <summary>
    /// set architecture of the target image
    /// </summary>
    [CliOption("--arch", Format = OptionFormat.EqualsSeparated)]
    public string? Arch { get; set; }

    /// <summary>
    /// set image author contact information
    /// </summary>
    [CliOption("--author", Format = OptionFormat.EqualsSeparated)]
    public string? Author { get; set; }

    /// <summary>
    /// set the default command to run for containers based on the image
    /// </summary>
    [CliOption("--cmd", Format = OptionFormat.EqualsSeparated)]
    public string? Cmd { get; set; }

    /// <summary>
    /// set a comment in the target image
    /// </summary>
    [CliOption("--comment", Format = OptionFormat.EqualsSeparated)]
    public string? Comment { get; set; }

    /// <summary>
    /// set description of how the image was created
    /// </summary>
    [CliOption("--created-by", Format = OptionFormat.EqualsSeparated)]
    public string? CreatedBy { get; set; }

    /// <summary>
    /// set a domain name for containers based on image
    /// </summary>
    [CliOption("--domainname", Format = OptionFormat.EqualsSeparated)]
    public string? Domainname { get; set; }

    /// <summary>
    /// set a healthcheck command for the target image
    /// </summary>
    [CliOption("--healthcheck", Format = OptionFormat.EqualsSeparated)]
    public string? Healthcheck { get; set; }

    /// <summary>
    /// set the interval between runs of the `healthcheck` command for the target image
    /// </summary>
    [CliOption("--healthcheck-interval", Format = OptionFormat.EqualsSeparated)]
    public string? HealthcheckInterval { get; set; }

    /// <summary>
    /// set the number of times the `healthcheck` command has to fail
    /// </summary>
    [CliOption("--healthcheck-retries", Format = OptionFormat.EqualsSeparated)]
    public int? HealthcheckRetries { get; set; }

    /// <summary>
    /// set the amount of time to wait after starting a container before a failed `healthcheck` command will count as a failure
    /// </summary>
    [CliOption("--healthcheck-start-period", Format = OptionFormat.EqualsSeparated)]
    public string? HealthcheckStartPeriod { get; set; }

    /// <summary>
    /// set the maximum amount of time to wait for a `healthcheck` command for the target image
    /// </summary>
    [CliOption("--healthcheck-timeout", Format = OptionFormat.EqualsSeparated)]
    public string? HealthcheckTimeout { get; set; }

    /// <summary>
    /// help for config
    /// </summary>
    [CliFlag("--help", ShortForm = "-h")]
    public bool? Help { get; set; }

    /// <summary>
    /// set a comment for the history of the target image
    /// </summary>
    [CliOption("--history-comment", Format = OptionFormat.EqualsSeparated)]
    public string? HistoryComment { get; set; }

    /// <summary>
    /// set a hostname for containers based on image
    /// </summary>
    [CliOption("--hostname", Format = OptionFormat.EqualsSeparated)]
    public string? Hostname { get; set; }

    /// <summary>
    /// add image configuration label e.g. label=value
    /// </summary>
    [CliOption("--label", ShortForm = "-l", Format = OptionFormat.EqualsSeparated)]
    public string? Label { get; set; }

    /// <summary>
    /// add onbuild command to be run on images based on this image. Only supported on 'docker' formatted images
    /// </summary>
    [CliOption("--onbuild", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Onbuild { get; set; }

    /// <summary>
    /// set required OS feature for the target image
    /// </summary>
    [CliOption("--os-feature", Format = OptionFormat.EqualsSeparated)]
    public string? OsFeature { get; set; }

    /// <summary>
    /// set required OS version for the target image
    /// </summary>
    [CliOption("--os-version", Format = OptionFormat.EqualsSeparated)]
    public string? OsVersion { get; set; }

    /// <summary>
    /// add port to expose when running containers based on image (default [])
    /// </summary>
    [CliOption("--port", ShortForm = "-p", Format = OptionFormat.EqualsSeparated)]
    public string? Port { get; set; }

    /// <summary>
    /// add shell to run in containers
    /// </summary>
    [CliOption("--shell", Format = OptionFormat.EqualsSeparated)]
    public string? Shell { get; set; }

    /// <summary>
    /// remove image configuration label
    /// </summary>
    [CliOption("--unsetlabel", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Unsetlabel { get; set; }

    /// <summary>
    /// set default user to run inside containers based on image
    /// </summary>
    [CliOption("--user", ShortForm = "-u", Format = OptionFormat.EqualsSeparated)]
    public string? User { get; set; }

    /// <summary>
    /// set architecture variant of the target image
    /// </summary>
    [CliOption("--variant", Format = OptionFormat.EqualsSeparated)]
    public string? Variant { get; set; }

    /// <summary>
    /// add default volume path to be created for containers based on image (default [])
    /// </summary>
    [CliOption("--volume", ShortForm = "-v", Format = OptionFormat.EqualsSeparated)]
    public string? Volume { get; set; }

    /// <summary>
    /// set working directory for containers based on image
    /// </summary>
    [CliOption("--workingdir", Format = OptionFormat.EqualsSeparated)]
    public string? Workingdir { get; set; }

}