BuildahSource.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 ModularPipelines.Context;
using ModularPipelines.Models;
using ModularPipelines.Options;
using ModularPipelines.Buildah.Options;

namespace ModularPipelines.Buildah.Services;

/// <summary>
/// buildah source commands.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
public class BuildahSource
{
    private readonly ICommand _command;

    /// <summary>
    /// Initializes a new instance of the <see cref="BuildahSource"/> class.
    /// </summary>
    public BuildahSource(ICommand command)
    {
        _command = command;
    }

    #region Commands

    /// <summary>
    /// Create, push, pull and manage source images and associated source artifacts.  A source image contains all source artifacts an ordinary OCI image has been built with.  Those artifacts can be any kind of source artifact, such as source RPMs, an entire source tree or text files.
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    public virtual async Task<CommandResult> Execute(
        BuildahSourceOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new BuildahSourceOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Add add a source artifact to a source image.  The artifact will be added as a gzip-compressed tar ball.  Add attempts to auto-tar and auto-compress only if necessary.
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    public virtual async Task<CommandResult> Add(
        BuildahSourceAddOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new BuildahSourceAddOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Create and initialize a source image.  A source image is an OCI artifact; an OCI image with a custom config media type.
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    public virtual async Task<CommandResult> Create(
        BuildahSourceCreateOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new BuildahSourceCreateOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Pull a source image from a registry to a specified path.  The pull operation will fail if the image does not comply with a source-image OCI artifact.
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    public virtual async Task<CommandResult> Pull(
        BuildahSourcePullOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new BuildahSourcePullOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Push a source image from a specified path to a registry.
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    public virtual async Task<CommandResult> Push(
        BuildahSourcePushOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new BuildahSourcePushOptions(), executionOptions, cancellationToken);
    }

    #endregion
}