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

Interface ConsensusTopicInfoOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Key
    getAdminKey()
    * A key that MUST sign any transaction to update or delete this topic.
    AccountID
    getAutoRenewAccount()
    * An account that is designated to pay automatic renewal fees.
    Duration
    getAutoRenewPeriod()
    * A duration, in seconds, to extend the `expirationTime` value when this topic is automatically renewed.
    FixedCustomFee
    getCustomFees(int index)
    * A set of custom fee definitions.<br/> These are fees to be assessed for each submit to this topic.
    int
    getCustomFeesCount()
    * A set of custom fee definitions.<br/> These are fees to be assessed for each submit to this topic.
    List<FixedCustomFee>
    getCustomFeesList()
    * A set of custom fee definitions.<br/> These are fees to be assessed for each submit to this topic.
    Timestamp
    getExpirationTime()
    * An expiration time for this topic, in seconds since the epoch.
    Key
    getFeeExemptKeyList(int index)
    * A set of keys.<br/> Keys in this list are permitted to submit messages to this topic without paying custom fees associated with this topic.
    int
    getFeeExemptKeyListCount()
    * A set of keys.<br/> Keys in this list are permitted to submit messages to this topic without paying custom fees associated with this topic.
    List<Key>
    getFeeExemptKeyListList()
    * A set of keys.<br/> Keys in this list are permitted to submit messages to this topic without paying custom fees associated with this topic.
    Key
    getFeeScheduleKey()
    * Access control for update/delete of custom fees.
    com.google.protobuf.ByteString
    getLedgerId()
    * A ledger ID of the network that generated this response.
    String
    getMemo()
    * A short description of this topic.
    com.google.protobuf.ByteString
    getMemoBytes()
    * A short description of this topic.
    com.google.protobuf.ByteString
    getRunningHash()
    * The latest running hash of the topic.
    long
    getSequenceNumber()
    * A current sequence number (starting at 1 for the first message) for messages on this topic.
    Key
    getSubmitKey()
    * A key that MUST sign any transaction to submit a message to this topic.
    boolean
    hasAdminKey()
    * A key that MUST sign any transaction to update or delete this topic.
    boolean
    hasAutoRenewAccount()
    * An account that is designated to pay automatic renewal fees.
    boolean
    hasAutoRenewPeriod()
    * A duration, in seconds, to extend the `expirationTime` value when this topic is automatically renewed.
    boolean
    hasExpirationTime()
    * An expiration time for this topic, in seconds since the epoch.
    boolean
    hasFeeScheduleKey()
    * Access control for update/delete of custom fees.
    boolean
    hasSubmitKey()
    * A key that MUST sign any transaction to submit a message to this topic.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getMemo

      String getMemo()
       *
 A short description of this topic.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 1;
      Returns:
      The memo.

    • getMemoBytes

      com.google.protobuf.ByteString getMemoBytes()
       *
 A short description of this topic.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 1;
      Returns:
      The bytes for memo.

    • getRunningHash

      com.google.protobuf.ByteString getRunningHash()
       *
 The latest running hash of the topic.
 <p>
 This 48-byte field is the output of a SHA-384 digest with input
 data determined by the current version of the running hash algorithm
 used by the network.<br/>
 All new transactions SHALL use algorithm version `3`.<br/>
 The bytes of each uint64 or uint32 encoded for the hash input
 MUST be in Big-Endian format.
 <p>
 <hr/>
 If the algorithm version is '3', then the input data to the
 SHA-384 digest are, in order:
 <ol>
 <li>The previous running hash of the topic (48 bytes)</li>
 <li>The `topicRunningHashVersion` (8 bytes)</li>
 <li>The payer account's shard (8 bytes)</li>
 <li>The payer account's realm (8 bytes)</li>
 <li>The payer account's number (8 bytes)</li>
 <li>The topic's shard (8 bytes)</li>
 <li>The topic's realm (8 bytes)</li>
 <li>The topic's number (8 bytes)</li>
 <li>The number of seconds since the epoch when the
 `ConsensusSubmitMessage` reached consensus (8 bytes)</li>
 <li>The number of nanoseconds within the second when the
 `ConsensusSubmitMessage` reached consensus (4 bytes)</li>
 <li>The `topicSequenceNumber` (8 bytes)</li>
 <li>The output of a SHA-384 digest of the message bytes from the
 `ConsensusSubmitMessage` (48 bytes)</li>
 </ol>
      bytes runningHash = 2;
      Returns:
      The runningHash.

    • getSequenceNumber

      long getSequenceNumber()
       *
 A current sequence number (starting at 1 for the first message)
 for messages on this topic.
      uint64 sequenceNumber = 3;
      Returns:
      The sequenceNumber.

    • hasExpirationTime

      boolean hasExpirationTime()
       *
 An expiration time for this topic, in seconds since the epoch.
 <p>
 For this purpose, `epoch` SHALL be the UNIX epoch
 with 0 at `1970-01-01T00:00:00.000Z`.
      .proto.Timestamp expirationTime = 4;
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      Timestamp getExpirationTime()
       *
 An expiration time for this topic, in seconds since the epoch.
 <p>
 For this purpose, `epoch` SHALL be the UNIX epoch
 with 0 at `1970-01-01T00:00:00.000Z`.
      .proto.Timestamp expirationTime = 4;
      Returns:
      The expirationTime.

    • hasAdminKey

      boolean hasAdminKey()
       *
 A key that MUST sign any transaction to update or delete this topic.
 <p>
 If this value is not set (null) then the topic CANNOT be deleted,
 modified, or updated.
      .proto.Key adminKey = 5;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 A key that MUST sign any transaction to update or delete this topic.
 <p>
 If this value is not set (null) then the topic CANNOT be deleted,
 modified, or updated.
      .proto.Key adminKey = 5;
      Returns:
      The adminKey.

    • hasSubmitKey

      boolean hasSubmitKey()
       *
 A key that MUST sign any transaction to submit a message to this topic.
 <p>
 If this value is not set (null) then any account MAY submit messages to
 this topic.
      .proto.Key submitKey = 6;
      Returns:
      Whether the submitKey field is set.

    • getSubmitKey

      Key getSubmitKey()
       *
 A key that MUST sign any transaction to submit a message to this topic.
 <p>
 If this value is not set (null) then any account MAY submit messages to
 this topic.
      .proto.Key submitKey = 6;
      Returns:
      The submitKey.

    • hasAutoRenewPeriod

      boolean hasAutoRenewPeriod()
       *
 A duration, in seconds, to extend the `expirationTime` value when
 this topic is automatically renewed.
 <p>
 If the `autoRenewAccount` value for this topic is set to a valid account
 with sufficient HBAR balance to pay renewal fees when this topic
 expires, the system SHALL automatically renew this topic, extending the
 `expirationTime` value by the number of seconds described here.<br/>
 If, however, the `autoRenewAccount` lacks sufficient HBAR balance
 to pay renewal fees when this topic expires, this topic SHALL be
 deleted after the time period specified in the `AUTORENEW_GRACE_PERIOD`
 configuration value.
      .proto.Duration autoRenewPeriod = 7;
      Returns:
      Whether the autoRenewPeriod field is set.

    • getAutoRenewPeriod

      Duration getAutoRenewPeriod()
       *
 A duration, in seconds, to extend the `expirationTime` value when
 this topic is automatically renewed.
 <p>
 If the `autoRenewAccount` value for this topic is set to a valid account
 with sufficient HBAR balance to pay renewal fees when this topic
 expires, the system SHALL automatically renew this topic, extending the
 `expirationTime` value by the number of seconds described here.<br/>
 If, however, the `autoRenewAccount` lacks sufficient HBAR balance
 to pay renewal fees when this topic expires, this topic SHALL be
 deleted after the time period specified in the `AUTORENEW_GRACE_PERIOD`
 configuration value.
      .proto.Duration autoRenewPeriod = 7;
      Returns:
      The autoRenewPeriod.

    • hasAutoRenewAccount

      boolean hasAutoRenewAccount()
       *
 An account that is designated to pay automatic renewal fees.
 <p>
 If this value is a valid account ID when this topic expires,
 this account SHALL be charged the renewal fees for this topic,
 if it holds sufficient HBAR balance. If the account does not hold
 sufficient HBAR balance to pay renewal fees when necessary, then
 this topic SHALL be deleted.<br/>
 If this value is not set (null), or is not a valid account ID, when
 this topic expires, then this topic SHALL be deleted after the time
 period specified in the `AUTORENEW_GRACE_PERIOD` configuration value.
      .proto.AccountID autoRenewAccount = 8;
      Returns:
      Whether the autoRenewAccount field is set.

    • getAutoRenewAccount

      AccountID getAutoRenewAccount()
       *
 An account that is designated to pay automatic renewal fees.
 <p>
 If this value is a valid account ID when this topic expires,
 this account SHALL be charged the renewal fees for this topic,
 if it holds sufficient HBAR balance. If the account does not hold
 sufficient HBAR balance to pay renewal fees when necessary, then
 this topic SHALL be deleted.<br/>
 If this value is not set (null), or is not a valid account ID, when
 this topic expires, then this topic SHALL be deleted after the time
 period specified in the `AUTORENEW_GRACE_PERIOD` configuration value.
      .proto.AccountID autoRenewAccount = 8;
      Returns:
      The autoRenewAccount.

    • getLedgerId

      com.google.protobuf.ByteString getLedgerId()
       *
 A ledger ID of the network that generated this response.
 <p>
 This value SHALL identify the distributed ledger that responded to
 this query.
      bytes ledger_id = 9;
      Returns:
      The ledgerId.

    • hasFeeScheduleKey

      boolean hasFeeScheduleKey()
       *
 Access control for update/delete of custom fees.
 <p>
 If unset, custom fees CANNOT be set for this topic.<br/>
 If not set when the topic is created, this field CANNOT be set via
 update.<br/>
 If set when the topic is created, this field MAY be changed via update.
      .proto.Key fee_schedule_key = 10;
      Returns:
      Whether the feeScheduleKey field is set.

    • getFeeScheduleKey

      Key getFeeScheduleKey()
       *
 Access control for update/delete of custom fees.
 <p>
 If unset, custom fees CANNOT be set for this topic.<br/>
 If not set when the topic is created, this field CANNOT be set via
 update.<br/>
 If set when the topic is created, this field MAY be changed via update.
      .proto.Key fee_schedule_key = 10;
      Returns:
      The feeScheduleKey.

    • getFeeExemptKeyListList

      List<Key> getFeeExemptKeyListList()
       *
 A set of keys.<br/>
 Keys in this list are permitted to submit messages to this topic without
 paying custom fees associated with this topic.
 <p>
 If a topic submit message is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If not set, there SHALL NOT be any fee-exempt keys.  In particular, the
 following keys SHALL NOT be implicitly or automatically added to this
 list: `adminKey`, `submitKey`, `fee_schedule_key`.
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.
      repeated .proto.Key fee_exempt_key_list = 11;

    • getFeeExemptKeyList

      Key getFeeExemptKeyList(int index)
       *
 A set of keys.<br/>
 Keys in this list are permitted to submit messages to this topic without
 paying custom fees associated with this topic.
 <p>
 If a topic submit message is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If not set, there SHALL NOT be any fee-exempt keys.  In particular, the
 following keys SHALL NOT be implicitly or automatically added to this
 list: `adminKey`, `submitKey`, `fee_schedule_key`.
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.
      repeated .proto.Key fee_exempt_key_list = 11;

    • getFeeExemptKeyListCount

      int getFeeExemptKeyListCount()
       *
 A set of keys.<br/>
 Keys in this list are permitted to submit messages to this topic without
 paying custom fees associated with this topic.
 <p>
 If a topic submit message is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If not set, there SHALL NOT be any fee-exempt keys.  In particular, the
 following keys SHALL NOT be implicitly or automatically added to this
 list: `adminKey`, `submitKey`, `fee_schedule_key`.
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.
      repeated .proto.Key fee_exempt_key_list = 11;

    • getCustomFeesList

      List<FixedCustomFee> getCustomFeesList()
       *
 A set of custom fee definitions.<br/>
 These are fees to be assessed for each submit to this topic.
 <p>
 Each fee defined in this set SHALL be evaluated for
 each message submitted to this topic, and the resultant
 total assessed fees SHALL be charged.<br/>
 Custom fees defined here SHALL be assessed in addition to the base
 network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 12;

    • getCustomFees

      FixedCustomFee getCustomFees(int index)
       *
 A set of custom fee definitions.<br/>
 These are fees to be assessed for each submit to this topic.
 <p>
 Each fee defined in this set SHALL be evaluated for
 each message submitted to this topic, and the resultant
 total assessed fees SHALL be charged.<br/>
 Custom fees defined here SHALL be assessed in addition to the base
 network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 12;

    • getCustomFeesCount

      int getCustomFeesCount()
       *
 A set of custom fee definitions.<br/>
 These are fees to be assessed for each submit to this topic.
 <p>
 Each fee defined in this set SHALL be evaluated for
 each message submitted to this topic, and the resultant
 total assessed fees SHALL be charged.<br/>
 Custom fees defined here SHALL be assessed in addition to the base
 network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 12;