TerraformState.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.Terraform.Options;

namespace ModularPipelines.Terraform.Services;

/// <summary>
/// terraform state commands.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
public class TerraformState
{
    private readonly ICommand _command;

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

    #region Commands

    /// <summary>
    /// List the json format of the identities of resources in the Terraform state.
    /// </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> Identities(
        TerraformStateIdentitiesOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateIdentitiesOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// List resources in the Terraform state.
    /// </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> List(
        TerraformStateListOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateListOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// This command will move an item matched by the address given to the
    /// </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> Mv(
        TerraformStateMvOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateMvOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Pull the state from its location, upgrade the local copy, and output it
    /// </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(
        TerraformStatePullOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStatePullOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Update remote state from a local state file at PATH.
    /// </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(
        TerraformStatePushOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStatePushOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Replace provider for resources in the Terraform state.
    /// </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> ReplaceProvider(
        TerraformStateReplaceProviderOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateReplaceProviderOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Remove one or more items from the Terraform state, causing Terraform to
    /// </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> Rm(
        TerraformStateRmOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateRmOptions(), executionOptions, cancellationToken);
    }

    /// <summary>
    /// Shows the attributes of a resource in the Terraform state.
    /// </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> Show(
        TerraformStateShowOptions options = default,
        CommandExecutionOptions executionOptions = null,
        CancellationToken cancellationToken = default)
    {
        return await _command.ExecuteCommandLineTool(options ?? new TerraformStateShowOptions(), executionOptions, cancellationToken);
    }

    #endregion
}