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

Interface FreezeTransactionBodyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
FreezeTransactionBody, FreezeTransactionBody.Builder
@Generated public interface FreezeTransactionBodyOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getEndHour()
    Deprecated.
    proto.FreezeTransactionBody.endHour is deprecated.
    int
    getEndMin()
    Deprecated.
    proto.FreezeTransactionBody.endMin is deprecated.
    com.google.protobuf.ByteString
    getFileHash()
    * A SHA384 hash of file content.<br/> This is a hash of the file identified by `update_file`.
    FreezeType
    getFreezeType()
    * The type of freeze.
    int
    getFreezeTypeValue()
    * The type of freeze.
    int
    getStartHour()
    Deprecated.
    proto.FreezeTransactionBody.startHour is deprecated.
    int
    getStartMin()
    Deprecated.
    proto.FreezeTransactionBody.startMin is deprecated.
    Timestamp
    getStartTime()
    * A start time for the freeze.
    FileID
    getUpdateFile()
    * An upgrade file.
    boolean
    hasStartTime()
    * A start time for the freeze.
    boolean
    hasUpdateFile()
    * An upgrade file.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getStartHour

      @Deprecated int getStartHour()
      Deprecated.
      proto.FreezeTransactionBody.startHour is deprecated. See freeze.proto;l=59
       *
 Rejected if set; replace with `start_time`.<br/>
 The start hour (in UTC time), a value between 0 and 23
      int32 startHour = 1 [deprecated = true];
      Returns:
      The startHour.

    • getStartMin

      @Deprecated int getStartMin()
      Deprecated.
      proto.FreezeTransactionBody.startMin is deprecated. See freeze.proto;l=65
       *
 Rejected if set; replace with `start_time`.<br/>
 The start minute (in UTC time), a value between 0 and 59
      int32 startMin = 2 [deprecated = true];
      Returns:
      The startMin.

    • getEndHour

      @Deprecated int getEndHour()
      Deprecated.
      proto.FreezeTransactionBody.endHour is deprecated. See freeze.proto;l=72
       *
 Rejected if set; end time is neither assigned nor guaranteed and depends
 on many uncontrolled factors.<br/>
 The end hour (in UTC time), a value between 0 and 23
      int32 endHour = 3 [deprecated = true];
      Returns:
      The endHour.

    • getEndMin

      @Deprecated int getEndMin()
      Deprecated.
      proto.FreezeTransactionBody.endMin is deprecated. See freeze.proto;l=79
       *
 Rejected if set; end time is neither assigned nor guaranteed and depends
 on many uncontrolled factors.<br/>
 The end minute (in UTC time), a value between 0 and 59
      int32 endMin = 4 [deprecated = true];
      Returns:
      The endMin.

    • hasUpdateFile

      boolean hasUpdateFile()
       *
 An upgrade file.
 <p>
 If set, the identifier of a file in network state.<br/>
 The contents of this file MUST be a `zip` file and this data
 SHALL be extracted to the node filesystem during a
 `PREPARE_UPGRADE` or `TELEMETRY_UPGRADE` freeze type.<br/>
 The `file_hash` field MUST match the SHA384 hash of the content
 of this file.<br/>
 The extracted data SHALL be used to perform a network software update
 if a `FREEZE_UPGRADE` freeze type is subsequently processed.
      .proto.FileID update_file = 5;
      Returns:
      Whether the updateFile field is set.

    • getUpdateFile

      FileID getUpdateFile()
       *
 An upgrade file.
 <p>
 If set, the identifier of a file in network state.<br/>
 The contents of this file MUST be a `zip` file and this data
 SHALL be extracted to the node filesystem during a
 `PREPARE_UPGRADE` or `TELEMETRY_UPGRADE` freeze type.<br/>
 The `file_hash` field MUST match the SHA384 hash of the content
 of this file.<br/>
 The extracted data SHALL be used to perform a network software update
 if a `FREEZE_UPGRADE` freeze type is subsequently processed.
      .proto.FileID update_file = 5;
      Returns:
      The updateFile.

    • getFileHash

      com.google.protobuf.ByteString getFileHash()
       *
 A SHA384 hash of file content.<br/>
 This is a hash of the file identified by `update_file`.
 <p>
 This MUST be set if `update_file` is set, and MUST match the
 SHA384 hash of the contents of that file.
      bytes file_hash = 6;
      Returns:
      The fileHash.

    • hasStartTime

      boolean hasStartTime()
       *
 A start time for the freeze.
 <p>
 If this field is REQUIRED for the specified `freeze_type`, then
 when the network consensus time reaches this instant<ol>
 <li>The network SHALL stop accepting transactions.</li>
 <li>The network SHALL gossip a freeze state.</li>
 <li>The nodes SHALL, in coordinated order, disconnect and
 shut down.</li>
 <li>The nodes SHALL halt or perform a software upgrade, depending
 on `freeze_type`.</li>
 <li>If the `freeze_type` is `FREEZE_UPGRADE`, the nodes SHALL
 restart and rejoin the network upon completion of the
 software upgrade.</li>
 </ol>
 <blockquote>
 If the `freeze_type` is `TELEMETRY_UPGRADE`, the start time is required,
 but the network SHALL NOT stop, halt, or interrupt transaction
 processing. The required field is an historical anomaly and SHOULD
 change in a future release.</blockquote>
      .proto.Timestamp start_time = 7;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      Timestamp getStartTime()
       *
 A start time for the freeze.
 <p>
 If this field is REQUIRED for the specified `freeze_type`, then
 when the network consensus time reaches this instant<ol>
 <li>The network SHALL stop accepting transactions.</li>
 <li>The network SHALL gossip a freeze state.</li>
 <li>The nodes SHALL, in coordinated order, disconnect and
 shut down.</li>
 <li>The nodes SHALL halt or perform a software upgrade, depending
 on `freeze_type`.</li>
 <li>If the `freeze_type` is `FREEZE_UPGRADE`, the nodes SHALL
 restart and rejoin the network upon completion of the
 software upgrade.</li>
 </ol>
 <blockquote>
 If the `freeze_type` is `TELEMETRY_UPGRADE`, the start time is required,
 but the network SHALL NOT stop, halt, or interrupt transaction
 processing. The required field is an historical anomaly and SHOULD
 change in a future release.</blockquote>
      .proto.Timestamp start_time = 7;
      Returns:
      The startTime.

    • getFreezeTypeValue

      int getFreezeTypeValue()
       *
 The type of freeze.
 <p>
 This REQUIRED field effectively selects between five quite different
 transactions in the same transaction body. Depending on this value
 the service may schedule a freeze, prepare upgrades, perform upgrades,
 or even abort a previously scheduled freeze.
      .proto.FreezeType freeze_type = 8;
      Returns:
      The enum numeric value on the wire for freezeType.

    • getFreezeType

      FreezeType getFreezeType()
       *
 The type of freeze.
 <p>
 This REQUIRED field effectively selects between five quite different
 transactions in the same transaction body. Depending on this value
 the service may schedule a freeze, prepare upgrades, perform upgrades,
 or even abort a previously scheduled freeze.
      .proto.FreezeType freeze_type = 8;
      Returns:
      The freezeType.