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

Class FreezeTransactionBody.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<FreezeTransactionBody,FreezeTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<FreezeTransactionBody,FreezeTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.FreezeTransactionBody.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, FreezeTransactionBodyOrBuilder, Cloneable
Enclosing class:
FreezeTransactionBody
public static final class FreezeTransactionBody.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<FreezeTransactionBody,FreezeTransactionBody.Builder> implements FreezeTransactionBodyOrBuilder
 *
 A transaction body for all five freeze transactions.

 Combining five different transactions into a single message, this
 transaction body MUST support options to schedule a freeze, abort a
 scheduled freeze, prepare a software upgrade, prepare a telemetry
 upgrade, or initiate a software upgrade.

 For a scheduled freeze, at the scheduled time, according to
 network consensus time
 - A freeze (`FREEZE_ONLY`) causes the network nodes to stop creating
 events or accepting transactions, and enter a persistent
 maintenance state.
 - A freeze upgrade (`FREEZE_UPGRADE`) causes the network nodes to stop
 creating events or accepting transactions, and upgrade the node software
 from a previously prepared upgrade package. The network nodes then
 restart and rejoin the network after upgrading.

 For other freeze types, immediately upon processing the freeze transaction
 - A Freeze Abort (`FREEZE_ABORT`) cancels any pending scheduled freeze.
 - A prepare upgrade (`PREPARE_UPGRADE`) begins to extract the contents of
 the specified upgrade file to the local filesystem.
 - A telemetry upgrade (`TELEMETRY_UPGRADE`) causes the network nodes to
 extract a telemetry upgrade package to the local filesystem and signal
 other software on the machine to upgrade, without impacting the node or
 network processing.

 ### Block Stream Effects
 Unknown
Protobuf type proto.FreezeTransactionBody

  • Method Details

    • getStartHour

      @Deprecated public 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];
      Specified by:
      getStartHour in interface FreezeTransactionBodyOrBuilder
      Returns:
      The startHour.

    • setStartHour

      @Deprecated public FreezeTransactionBody.Builder setStartHour(int value)
      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];
      Parameters:
      value - The startHour to set.
      Returns:
      This builder for chaining.

    • clearStartHour

      @Deprecated public FreezeTransactionBody.Builder clearStartHour()
      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:
      This builder for chaining.

    • getStartMin

      @Deprecated public 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];
      Specified by:
      getStartMin in interface FreezeTransactionBodyOrBuilder
      Returns:
      The startMin.

    • setStartMin

      @Deprecated public FreezeTransactionBody.Builder setStartMin(int value)
      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];
      Parameters:
      value - The startMin to set.
      Returns:
      This builder for chaining.

    • clearStartMin

      @Deprecated public FreezeTransactionBody.Builder clearStartMin()
      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:
      This builder for chaining.

    • getEndHour

      @Deprecated public 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];
      Specified by:
      getEndHour in interface FreezeTransactionBodyOrBuilder
      Returns:
      The endHour.

    • setEndHour

      @Deprecated public FreezeTransactionBody.Builder setEndHour(int value)
      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];
      Parameters:
      value - The endHour to set.
      Returns:
      This builder for chaining.

    • clearEndHour

      @Deprecated public FreezeTransactionBody.Builder clearEndHour()
      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:
      This builder for chaining.

    • getEndMin

      @Deprecated public 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];
      Specified by:
      getEndMin in interface FreezeTransactionBodyOrBuilder
      Returns:
      The endMin.

    • setEndMin

      @Deprecated public FreezeTransactionBody.Builder setEndMin(int value)
      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];
      Parameters:
      value - The endMin to set.
      Returns:
      This builder for chaining.

    • clearEndMin

      @Deprecated public FreezeTransactionBody.Builder clearEndMin()
      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:
      This builder for chaining.

    • hasUpdateFile

      public 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;
      Specified by:
      hasUpdateFile in interface FreezeTransactionBodyOrBuilder
      Returns:
      Whether the updateFile field is set.

    • getUpdateFile

      public 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;
      Specified by:
      getUpdateFile in interface FreezeTransactionBodyOrBuilder
      Returns:
      The updateFile.

    • setUpdateFile

      public FreezeTransactionBody.Builder setUpdateFile(FileID value)
       *
 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;

    • setUpdateFile

      public FreezeTransactionBody.Builder setUpdateFile(FileID.Builder builderForValue)
       *
 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;

    • mergeUpdateFile

      public FreezeTransactionBody.Builder mergeUpdateFile(FileID value)
       *
 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;

    • clearUpdateFile

      public FreezeTransactionBody.Builder clearUpdateFile()
       *
 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;

    • getFileHash

      public 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;
      Specified by:
      getFileHash in interface FreezeTransactionBodyOrBuilder
      Returns:
      The fileHash.

    • setFileHash

      public FreezeTransactionBody.Builder setFileHash(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The fileHash to set.
      Returns:
      This builder for chaining.

    • clearFileHash

      public FreezeTransactionBody.Builder clearFileHash()
       *
 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:
      This builder for chaining.

    • hasStartTime

      public 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;
      Specified by:
      hasStartTime in interface FreezeTransactionBodyOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public 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;
      Specified by:
      getStartTime in interface FreezeTransactionBodyOrBuilder
      Returns:
      The startTime.

    • setStartTime

      public FreezeTransactionBody.Builder setStartTime(Timestamp value)
       *
 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;

    • setStartTime

      public FreezeTransactionBody.Builder setStartTime(Timestamp.Builder builderForValue)
       *
 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;

    • mergeStartTime

      public FreezeTransactionBody.Builder mergeStartTime(Timestamp value)
       *
 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;

    • clearStartTime

      public FreezeTransactionBody.Builder clearStartTime()
       *
 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;

    • getFreezeTypeValue

      public 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;
      Specified by:
      getFreezeTypeValue in interface FreezeTransactionBodyOrBuilder
      Returns:
      The enum numeric value on the wire for freezeType.

    • setFreezeTypeValue

      public FreezeTransactionBody.Builder setFreezeTypeValue(int value)
       *
 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;
      Parameters:
      value - The freezeType to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • getFreezeType

      public 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;
      Specified by:
      getFreezeType in interface FreezeTransactionBodyOrBuilder
      Returns:
      The freezeType.

    • setFreezeType

      public FreezeTransactionBody.Builder setFreezeType(FreezeType value)
       *
 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;
      Parameters:
      value - The enum numeric value on the wire for freezeType to set.
      Returns:
      This builder for chaining.

    • clearFreezeType

      public FreezeTransactionBody.Builder clearFreezeType()
       *
 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:
      This builder for chaining.