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

Enum Class FreezeType

java.lang.Object
java.lang.Enum<FreezeType>
com.hedera.hashgraph.sdk.proto.FreezeType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, Serializable, Comparable<FreezeType>, Constable
@Generated public enum FreezeType extends Enum<FreezeType> implements com.google.protobuf.Internal.EnumLite
 *
 An enumeration of possible network freeze types.

 Each enumerated value SHALL be associated to a single network freeze
 scenario. Each freeze scenario defines the specific parameters
 REQUIRED for that freeze.
Protobuf enum proto.FreezeType

  • Enum Constant Details

    • UNKNOWN_FREEZE_TYPE

      public static final FreezeType UNKNOWN_FREEZE_TYPE
       *
 An invalid freeze type.
 <p>
 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.
      UNKNOWN_FREEZE_TYPE = 0;

    • FREEZE_ONLY

      public static final FreezeType FREEZE_ONLY
       *
 Freeze the network, and take no further action.
 <p>
 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.<br/>
 The fields `update_file` and `file_hash` SHALL be ignored.<br/>
 A `FREEZE_ONLY` transaction SHALL NOT perform any network
 changes or upgrades.<br/>
 After this freeze is processed manual intervention is REQUIRED
 to restart the network.
      FREEZE_ONLY = 1;

    • PREPARE_UPGRADE

      public static final FreezeType PREPARE_UPGRADE
       *
 This freeze type does not freeze the network, but begins
 "preparation" to upgrade the network.
 <p>
 The fields `update_file` and `file_hash` are REQUIRED
 and MUST be valid.<br/>
 The `start_time` field SHALL be ignored.<br/>
 A `PREPARE_UPGRADE` transaction SHALL NOT freeze the network or
 interfere with general transaction processing.<br/>
 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.<br/>
 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.
      PREPARE_UPGRADE = 2;

    • FREEZE_UPGRADE

      public static final FreezeType FREEZE_UPGRADE
       *
 Freeze the network to perform a software upgrade.
 <p>
 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.<br/>
 A software upgrade file MUST be prepared prior to this transaction.<br/>
 After this transaction completes, the network SHALL initiate an
 upgrade and restart of all nodes at the start time specified.
      FREEZE_UPGRADE = 3;

    • FREEZE_ABORT

      public static final FreezeType FREEZE_ABORT
       *
 Abort a pending network freeze operation.
 <p>
 All fields SHALL be ignored for this freeze type.<br/>
 This freeze type MAY be submitted after a `FREEZE_ONLY`,
 `FREEZE_UPGRADE`, or `TELEMETRY_UPGRADE` is initiated.<br/>
 This freeze type MUST be submitted and reach consensus
 before the `start_time` designated for the current pending
 freeze to be effective.<br/>
 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.
      FREEZE_ABORT = 4;

    • TELEMETRY_UPGRADE

      public static final FreezeType TELEMETRY_UPGRADE
       *
 Prepare an upgrade of auxiliary services and containers
 providing telemetry/metrics.
 <p>
 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.<br/>
 The `update_file` field is REQUIRED and MUST be valid.<br/>
 A `TELEMETRY_UPGRADE` transaction SHALL NOT freeze the network or
 interfere with general transaction processing.<br/>
 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.<br/>
 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.
 <blockquote> The condition that `start_time` is REQUIRED is an
 historical anomaly and SHOULD change in a future release.</blockquote>
      TELEMETRY_UPGRADE = 5;

    • UNRECOGNIZED

      public static final FreezeType UNRECOGNIZED

  • Field Details

    • UNKNOWN_FREEZE_TYPE_VALUE

      public static final int UNKNOWN_FREEZE_TYPE_VALUE
       *
 An invalid freeze type.
 <p>
 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.
      UNKNOWN_FREEZE_TYPE = 0;
      See Also:

    • FREEZE_ONLY_VALUE

      public static final int FREEZE_ONLY_VALUE
       *
 Freeze the network, and take no further action.
 <p>
 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.<br/>
 The fields `update_file` and `file_hash` SHALL be ignored.<br/>
 A `FREEZE_ONLY` transaction SHALL NOT perform any network
 changes or upgrades.<br/>
 After this freeze is processed manual intervention is REQUIRED
 to restart the network.
      FREEZE_ONLY = 1;
      See Also:

    • PREPARE_UPGRADE_VALUE

      public static final int PREPARE_UPGRADE_VALUE
       *
 This freeze type does not freeze the network, but begins
 "preparation" to upgrade the network.
 <p>
 The fields `update_file` and `file_hash` are REQUIRED
 and MUST be valid.<br/>
 The `start_time` field SHALL be ignored.<br/>
 A `PREPARE_UPGRADE` transaction SHALL NOT freeze the network or
 interfere with general transaction processing.<br/>
 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.<br/>
 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.
      PREPARE_UPGRADE = 2;
      See Also:

    • FREEZE_UPGRADE_VALUE

      public static final int FREEZE_UPGRADE_VALUE
       *
 Freeze the network to perform a software upgrade.
 <p>
 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.<br/>
 A software upgrade file MUST be prepared prior to this transaction.<br/>
 After this transaction completes, the network SHALL initiate an
 upgrade and restart of all nodes at the start time specified.
      FREEZE_UPGRADE = 3;
      See Also:

    • FREEZE_ABORT_VALUE

      public static final int FREEZE_ABORT_VALUE
       *
 Abort a pending network freeze operation.
 <p>
 All fields SHALL be ignored for this freeze type.<br/>
 This freeze type MAY be submitted after a `FREEZE_ONLY`,
 `FREEZE_UPGRADE`, or `TELEMETRY_UPGRADE` is initiated.<br/>
 This freeze type MUST be submitted and reach consensus
 before the `start_time` designated for the current pending
 freeze to be effective.<br/>
 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.
      FREEZE_ABORT = 4;
      See Also:

    • TELEMETRY_UPGRADE_VALUE

      public static final int TELEMETRY_UPGRADE_VALUE
       *
 Prepare an upgrade of auxiliary services and containers
 providing telemetry/metrics.
 <p>
 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.<br/>
 The `update_file` field is REQUIRED and MUST be valid.<br/>
 A `TELEMETRY_UPGRADE` transaction SHALL NOT freeze the network or
 interfere with general transaction processing.<br/>
 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.<br/>
 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.
 <blockquote> The condition that `start_time` is REQUIRED is an
 historical anomaly and SHOULD change in a future release.</blockquote>
      TELEMETRY_UPGRADE = 5;
      See Also:

  • 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

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite

    • valueOf

      @Deprecated public static FreezeType valueOf(int value)
      Deprecated.
      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:
      value - 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

    • forNumber

      public static FreezeType forNumber(int value)

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<FreezeType> internalGetValueMap()

    • internalGetVerifier

      public static com.google.protobuf.Internal.EnumVerifier internalGetVerifier()