Class ScheduleTelemetryUpgradeExtensions

Extension methods for scheduling a telemetry upgrade.

Inheritance

object

ScheduleTelemetryUpgradeExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public static class ScheduleTelemetryUpgradeExtensions

Methods

ScheduleTelemetryUpgradeAsync(ConsensusClient, ScheduleTelemetryUpgradeParams, Action<IConsensusContext>?)

Schedules an immediate upgrade of auxiliary services and containers providing telemetry and metrics. Does not impact ongoing network operations.

Declaration

public static Task<TransactionReceipt> ScheduleTelemetryUpgradeAsync(this ConsensusClient client, ScheduleTelemetryUpgradeParams scheduleParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the administrative command.
ScheduleTelemetryUpgradeParams	scheduleParams	The parameters for scheduling the telemetry upgrade.
Action<IConsensusContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A TransactionId Receipt indicating success.

Remarks

This operation must be submitted by a privileged account having access rights to perform this operation.

Examples

// Schedule a telemetry-config refresh across the node fleet. Used by
// Hedera operators to roll out observability changes without a full
// software upgrade.
var receipt = await client.ScheduleTelemetryUpgradeAsync(new ScheduleTelemetryUpgradeParams());
Console.WriteLine($"Telemetry schedule status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the request as invalid or had missing data.