Joseph Doherty
68 lines
2.6 KiB
C#
68 lines
2.6 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Types.Transport;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
|
|
|
/// <summary>
|
|
/// Exports a bundle. Names rather than IDs in the selection so test scripts can
|
|
/// be written without an ID lookup step. <c>All=true</c> overrides the per-type
|
|
/// name lists and exports every entity of every supported type.
|
|
/// <para>
|
|
/// Inbound API keys are intentionally not selectable: per the inbound-API-key
|
|
/// re-architecture (C4) keys are not transported between environments; only API
|
|
/// methods travel. Re-create keys and re-grant their method scopes on the
|
|
/// destination via the admin UI/CLI.
|
|
/// </para>
|
|
/// </summary>
|
|
public sealed record ExportBundleCommand(
|
|
bool All,
|
|
IReadOnlyList<string>? TemplateNames,
|
|
IReadOnlyList<string>? SharedScriptNames,
|
|
IReadOnlyList<string>? ExternalSystemNames,
|
|
IReadOnlyList<string>? DatabaseConnectionNames,
|
|
IReadOnlyList<string>? NotificationListNames,
|
|
IReadOnlyList<string>? SmtpConfigurationNames,
|
|
IReadOnlyList<string>? ApiMethodNames,
|
|
bool IncludeDependencies,
|
|
string? Passphrase,
|
|
string SourceEnvironment);
|
|
|
|
/// <summary>
|
|
/// Bundle body returned as base64-encoded ZIP. <see cref="ByteCount"/> is the
|
|
/// pre-encoded size for sanity checks against the configured bundle cap.
|
|
/// </summary>
|
|
public sealed record ExportBundleResult(
|
|
string Base64Bundle,
|
|
int ByteCount);
|
|
|
|
/// <summary>
|
|
/// Loads a bundle and returns its preview without applying anything. Useful
|
|
/// for tests that want to assert on the diff shape before committing.
|
|
/// </summary>
|
|
public sealed record PreviewBundleCommand(
|
|
string Base64Bundle,
|
|
string? Passphrase);
|
|
|
|
public sealed record PreviewBundleResult(
|
|
IReadOnlyList<ImportPreviewItem> Items,
|
|
int AddCount,
|
|
int ModifiedCount,
|
|
int IdenticalCount,
|
|
int BlockerCount);
|
|
|
|
/// <summary>
|
|
/// Loads, previews, and applies a bundle in a single call. The diff is built
|
|
/// internally; every <see cref="ConflictKind.Modified"/> row is resolved with
|
|
/// <see cref="DefaultConflictPolicy"/>, every <see cref="ConflictKind.New"/>
|
|
/// row gets <see cref="ResolutionAction.Add"/>, every
|
|
/// <see cref="ConflictKind.Identical"/> row gets <see cref="ResolutionAction.Skip"/>,
|
|
/// and any <see cref="ConflictKind.Blocker"/> row fails the call.
|
|
/// <para>
|
|
/// Valid <see cref="DefaultConflictPolicy"/> values: <c>"skip"</c>,
|
|
/// <c>"overwrite"</c>, <c>"rename"</c>. Rename mints a unique suffix per row.
|
|
/// </para>
|
|
/// </summary>
|
|
public sealed record ImportBundleCommand(
|
|
string Base64Bundle,
|
|
string? Passphrase,
|
|
string DefaultConflictPolicy);
|