Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk

Enum Class FreezeType

java.lang.Object
java.lang.Enum<FreezeType>
com.hedera.hashgraph.sdk.FreezeType
All Implemented Interfaces:
Serializable, Comparable<FreezeType>, Constable
public enum FreezeType extends Enum<FreezeType>
Enum for the freeze types.

  • Enum Constant Details

    • UNKNOWN_FREEZE_TYPE

      public static final FreezeType UNKNOWN_FREEZE_TYPE
      An invalid freeze type.

      The first value in a protobuf enum is a default value. This default is RECOMMENDED to be an invalid value to aid in detecting unset fields.

    • FREEZE_ONLY

      public static final FreezeType FREEZE_ONLY
      Freeze the network, and take no further action.

      The `start_time` field is REQUIRED, MUST be strictly later than the consensus time when this transaction is handled, and SHOULD be between `300` and `3600` seconds after the transaction identifier `transactionValidStart` field.
      The fields `update_file` and `file_hash` SHALL be ignored.
      A `FREEZE_ONLY` transaction SHALL NOT perform any network changes or upgrades.
      After this freeze is processed manual intervention is REQUIRED to restart the network.

    • PREPARE_UPGRADE

      public static final FreezeType PREPARE_UPGRADE
      This freeze type does not freeze the network, but begins "preparation" to upgrade the network.

      The fields `update_file` and `file_hash` are REQUIRED and MUST be valid.
      The `start_time` field SHALL be ignored.
      A `PREPARE_UPGRADE` transaction SHALL NOT freeze the network or interfere with general transaction processing.
      If this freeze type is initiated after a `TELEMETRY_UPGRADE`, the prepared telemetry upgrade SHALL be reset and all telemetry upgrade artifacts in the filesystem SHALL be deleted.
      At some point after this freeze type completes (dependent on the size of the upgrade file), the network SHALL be prepared to complete a software upgrade of all nodes.

    • FREEZE_UPGRADE

      public static final FreezeType FREEZE_UPGRADE
      Freeze the network to perform a software upgrade.

      The `start_time` field is REQUIRED, MUST be strictly later than the consensus time when this transaction is handled, and SHOULD be between `300` and `3600` seconds after the transaction identifier `transactionValidStart` field.
      A software upgrade file MUST be prepared prior to this transaction.
      After this transaction completes, the network SHALL initiate an upgrade and restart of all nodes at the start time specified.

    • FREEZE_ABORT

      public static final FreezeType FREEZE_ABORT
      Abort a pending network freeze operation.

      All fields SHALL be ignored for this freeze type.
      This freeze type MAY be submitted after a `FREEZE_ONLY`, `FREEZE_UPGRADE`, or `TELEMETRY_UPGRADE` is initiated.
      This freeze type MUST be submitted and reach consensus before the `start_time` designated for the current pending freeze to be effective.
      After this freeze type is processed, the upgrade file hash and pending freeze start time stored in the network SHALL be reset to default (empty) values.

    • TELEMETRY_UPGRADE

      public static final FreezeType TELEMETRY_UPGRADE
      Prepare an upgrade of auxiliary services and containers providing telemetry/metrics.

      The `start_time` field is REQUIRED, MUST be strictly later than the consensus time when this transaction is handled, and SHOULD be between `300` and `3600` seconds after the transaction identifier `transactionValidStart` field.
      The `update_file` field is REQUIRED and MUST be valid.
      A `TELEMETRY_UPGRADE` transaction SHALL NOT freeze the network or interfere with general transaction processing.
      This freeze type MUST NOT be initiated between a `PREPARE_UPGRADE` and `FREEZE_UPGRADE`. If this freeze type is initiated after a `PREPARE_UPGRADE`, the prepared upgrade SHALL be reset and all software upgrade artifacts in the filesystem SHALL be deleted.
      At some point after this freeze type completes (dependent on the size of the upgrade file), the network SHALL automatically upgrade the telemetry/metrics services and containers as directed in the specified telemetry upgrade file.

      The condition that `start_time` is REQUIRED is an historical anomaly and SHOULD change in a future release.

  • Field Details

  • Method Details

    • values

      public static FreezeType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FreezeType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      static FreezeType valueOf(FreezeType code)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      code - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<FreezeType>