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

Class FreezeTransactionBody

java.lang.Object
com.google.protobuf.AbstractMessageLite<FreezeTransactionBody,FreezeTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite<FreezeTransactionBody,FreezeTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.FreezeTransactionBody
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, FreezeTransactionBodyOrBuilder
@Generated public final class FreezeTransactionBody extends com.google.protobuf.GeneratedMessageLite<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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FreezeTransactionBody.Builder
    * A transaction body for all five freeze transactions.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENDHOUR_FIELD_NUMBER
     
    static final int
    ENDMIN_FIELD_NUMBER
     
    static final int
    FILE_HASH_FIELD_NUMBER
     
    static final int
    FREEZE_TYPE_FIELD_NUMBER
     
    static final int
    START_TIME_FIELD_NUMBER
     
    static final int
    STARTHOUR_FIELD_NUMBER
     
    static final int
    STARTMIN_FIELD_NUMBER
     
    static final int
    UPDATE_FILE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static FreezeTransactionBody
    getDefaultInstance()
     
    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.
    static FreezeTransactionBody.Builder
    newBuilder()
     
    static FreezeTransactionBody.Builder
    newBuilder(FreezeTransactionBody prototype)
     
    static FreezeTransactionBody
    parseDelimitedFrom(InputStream input)
     
    static FreezeTransactionBody
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FreezeTransactionBody
    parseFrom(byte[] data)
     
    static FreezeTransactionBody
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FreezeTransactionBody
    parseFrom(com.google.protobuf.ByteString data)
     
    static FreezeTransactionBody
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FreezeTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FreezeTransactionBody
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FreezeTransactionBody
    parseFrom(InputStream input)
     
    static FreezeTransactionBody
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FreezeTransactionBody
    parseFrom(ByteBuffer data)
     
    static FreezeTransactionBody
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FreezeTransactionBody>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • parseFrom

      public static FreezeTransactionBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FreezeTransactionBody parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FreezeTransactionBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FreezeTransactionBody parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FreezeTransactionBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FreezeTransactionBody parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FreezeTransactionBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static FreezeTransactionBody.Builder newBuilder()

    • newBuilder

      public static FreezeTransactionBody.Builder newBuilder(FreezeTransactionBody prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<FreezeTransactionBody,FreezeTransactionBody.Builder>

    • getDefaultInstance

      public static FreezeTransactionBody getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FreezeTransactionBody> parser()