Joseph Doherty
a1156960b9
Resolves 1113 documentation-completeness gaps flagged by CommentChecker (MissingReturns, MissingInheritDoc, InheritDocMisused, MissingDoc, MissingParam, RedundantInheritDoc) so the API surface is fully documented and the analyzer scan is clean. Doc comments only; no code changes.
55 lines
2.7 KiB
C#
55 lines
2.7 KiB
C#
using Grpc.Core;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Client;
|
|
|
|
/// <summary>Transport layer for Galaxy Repository gRPC operations.</summary>
|
|
internal interface IGalaxyRepositoryClientTransport
|
|
{
|
|
/// <summary>Gets the client options used to configure this transport.</summary>
|
|
MxGatewayClientOptions Options { get; }
|
|
|
|
/// <summary>Gets the underlying gRPC client, or <c>null</c> if not yet initialized.</summary>
|
|
GalaxyRepository.GalaxyRepositoryClient? RawClient { get; }
|
|
|
|
/// <summary>Tests the connection to the Galaxy Repository server.</summary>
|
|
/// <param name="request">The test connection request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>A task that resolves to the test connection reply.</returns>
|
|
Task<TestConnectionReply> TestConnectionAsync(
|
|
TestConnectionRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Gets the last deploy time from the Galaxy Repository server.</summary>
|
|
/// <param name="request">The get last deploy time request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>A task that resolves to the last deploy time reply.</returns>
|
|
Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
|
GetLastDeployTimeRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Discovers the object hierarchy in the Galaxy Repository.</summary>
|
|
/// <param name="request">The discover hierarchy request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>A task that resolves to the hierarchy discovery reply.</returns>
|
|
Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
|
DiscoverHierarchyRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Returns direct children of a parent in the Galaxy hierarchy.</summary>
|
|
/// <param name="request">The browse children request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>A task that resolves to the browse children reply.</returns>
|
|
Task<BrowseChildrenReply> BrowseChildrenAsync(
|
|
BrowseChildrenRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Watches for deployment events from the Galaxy Repository server.</summary>
|
|
/// <param name="request">The watch deploy events request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>An async enumerable of deploy events.</returns>
|
|
IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
|
WatchDeployEventsRequest request,
|
|
CallOptions callOptions);
|
|
}
|