BuildahPullOptions.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>
/// Pulls an image from a registry and stores it locally.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
[ExcludeFromCodeCoverage]
[CliSubCommand("pull")]
public record BuildahPullOptions : BuildahOptions
{
    /// <summary>
    /// download all tagged images in the repository
    /// </summary>
    [CliFlag("--all-tags", ShortForm = "-a")]
    public bool? AllTags { get; set; }

    /// <summary>
    /// prefer ARCH instead of the architecture of the machine for choosing images (default "amd64")
    /// </summary>
    [CliOption("--arch", Format = OptionFormat.EqualsSeparated)]
    public string? Arch { get; set; }

    /// <summary>
    /// path of the authentication file. Use REGISTRY_AUTH_FILE environment variable to override
    /// </summary>
    [CliOption("--authfile", Format = OptionFormat.EqualsSeparated)]
    public string? Authfile { get; set; }

    /// <summary>
    /// use certificates at the specified path to access the registry
    /// </summary>
    [CliOption("--cert-dir", Format = OptionFormat.EqualsSeparated)]
    public string? CertDir { get; set; }

    /// <summary>
    /// use [username[:password]] for accessing the registry
    /// </summary>
    [CliOption("--creds", Format = OptionFormat.EqualsSeparated)]
    public string? Creds { get; set; }

    /// <summary>
    /// key needed to decrypt the image
    /// </summary>
    [CliOption("--decryption-key", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? DecryptionKey { get; set; }

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

    /// <summary>
    /// prefer OS instead of the running OS for choosing images (default "linux")
    /// </summary>
    [CliOption("--os", Format = OptionFormat.EqualsSeparated)]
    public string? Os { get; set; }

    /// <summary>
    /// prefer OS/ARCH instead of the current operating system and architecture for choosing images (default [linux/amd64])
    /// </summary>
    [CliOption("--platform", Format = OptionFormat.EqualsSeparated, AllowMultiple = true)]
    public IEnumerable<string>? Platform { get; set; }

    /// <summary>
    /// missing, always, ifnewer, or never. (default "missing")
    /// </summary>
    [CliOption("--policy", Format = OptionFormat.EqualsSeparated)]
    public string? Policy { get; set; }

    /// <summary>
    /// don't output progress information when pulling images
    /// </summary>
    [CliFlag("--quiet", ShortForm = "-q")]
    public bool? Quiet { get; set; }

    /// <summary>
    /// don't copy signatures when pulling image
    /// </summary>
    [CliFlag("--remove-signatures")]
    public bool? RemoveSignatures { get; set; }

    /// <summary>
    /// number of times to retry in case of failure when performing pull (default 3)
    /// </summary>
    [CliOption("--retry", Format = OptionFormat.EqualsSeparated)]
    public int? Retry { get; set; }

    /// <summary>
    /// delay between retries in case of pull failures (default "2s")
    /// </summary>
    [CliOption("--retry-delay", Format = OptionFormat.EqualsSeparated)]
    public string? RetryDelay { get; set; }

    /// <summary>
    /// require HTTPS and verify certificates when accessing the registry. TLS verification cannot be used when talking to an insecure registry. (default true)
    /// </summary>
    [CliFlag("--tls-verify")]
    public bool? TlsVerify { get; set; }

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

}