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

Interface TopicOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Key
    getAdminKey()
    * Access control for modification of the topic.
    AccountID
    getAutoRenewAccountId()
    * The id of the account (if any) that the network will attempt to charge fees to complete auto-renewal of this topic, upon expiration.
    long
    getAutoRenewPeriod()
    * The number of seconds for which the topic will be automatically renewed upon expiring (if it has a valid auto-renew account).
    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.
    boolean
    getDeleted()
    * A flag indicating that this topic is deleted.
    long
    getExpirationSecond()
    * The expiration time for this topic, in seconds since the epoch.
    Key
    getFeeExemptKeyList(int index)
    * A set of "privileged payer" 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 "privileged payer" 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 "privileged payer" 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.
    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 current running hash of this topic.
    long
    getSequenceNumber()
    * The number of messages sent to the topic.
    Key
    getSubmitKey()
    * Access control for message submission to the topic.
    TopicID
    getTopicId()
    * The topic's ID.
    boolean
    hasAdminKey()
    * Access control for modification of the topic.
    boolean
    hasAutoRenewAccountId()
    * The id of the account (if any) that the network will attempt to charge fees to complete auto-renewal of this topic, upon expiration.
    boolean
    hasFeeScheduleKey()
    * Access control for update/delete of custom fees.
    boolean
    hasSubmitKey()
    * Access control for message submission to the topic.
    boolean
    hasTopicId()
    * The topic's ID.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasTopicId

      boolean hasTopicId()
       *
 The topic's ID.
 <p>
 This value SHALL be unique within the network.
      .proto.TopicID topic_id = 1;
      Returns:
      Whether the topicId field is set.

    • getTopicId

      TopicID getTopicId()
       *
 The topic's ID.
 <p>
 This value SHALL be unique within the network.
      .proto.TopicID topic_id = 1;
      Returns:
      The topicId.

    • getSequenceNumber

      long getSequenceNumber()
       *
 The number of messages sent to the topic.
      int64 sequence_number = 2;
      Returns:
      The sequenceNumber.

    • getExpirationSecond

      long getExpirationSecond()
       *
 The 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`.
      int64 expiration_second = 3;
      Returns:
      The expirationSecond.

    • getAutoRenewPeriod

      long getAutoRenewPeriod()
       *
 The number of seconds for which the topic will be automatically renewed
 upon expiring (if it has a valid auto-renew account).
      int64 auto_renew_period = 4;
      Returns:
      The autoRenewPeriod.

    • hasAutoRenewAccountId

      boolean hasAutoRenewAccountId()
       *
 The id of the account (if any) that the network will attempt to charge
 fees to complete auto-renewal of this topic, upon expiration.
      .proto.AccountID auto_renew_account_id = 5;
      Returns:
      Whether the autoRenewAccountId field is set.

    • getAutoRenewAccountId

      AccountID getAutoRenewAccountId()
       *
 The id of the account (if any) that the network will attempt to charge
 fees to complete auto-renewal of this topic, upon expiration.
      .proto.AccountID auto_renew_account_id = 5;
      Returns:
      The autoRenewAccountId.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating that this topic is deleted.
      bool deleted = 6;
      Returns:
      The deleted.

    • getRunningHash

      com.google.protobuf.ByteString getRunningHash()
       *
 The current running hash of this 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 topics in state SHALL use running hash 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>
 <blockquote>Note that older messages on a topic, which are available in
 the block stream, MAY use older algorithm versions, and the block stream
 record incorporates a running hash version field to ensure the correct
 hash calculation for each such historical message.</blockquote>
      bytes running_hash = 7;
      Returns:
      The runningHash.

    • 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 = 8;
      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 = 8;
      Returns:
      The bytes for memo.

    • hasAdminKey

      boolean hasAdminKey()
       *
 Access control for modification of the topic.
 <p>
 If this field is set, that key MUST sign each message to update or delete
 this topic.<br/>
 A topic without an admin key SHALL be immutable, except for expiration
 and renewal.<br/>
 If this field is not set, the `auto_renew_account_id` MUST NOT be set.
      .proto.Key admin_key = 9;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 Access control for modification of the topic.
 <p>
 If this field is set, that key MUST sign each message to update or delete
 this topic.<br/>
 A topic without an admin key SHALL be immutable, except for expiration
 and renewal.<br/>
 If this field is not set, the `auto_renew_account_id` MUST NOT be set.
      .proto.Key admin_key = 9;
      Returns:
      The adminKey.

    • hasSubmitKey

      boolean hasSubmitKey()
       *
 Access control for message submission to the topic.
 <p>
 If this field is set, that key MUST sign each consensus submit message
 for this topic.
      .proto.Key submit_key = 10;
      Returns:
      Whether the submitKey field is set.

    • getSubmitKey

      Key getSubmitKey()
       *
 Access control for message submission to the topic.
 <p>
 If this field is set, that key MUST sign each consensus submit message
 for this topic.
      .proto.Key submit_key = 10;
      Returns:
      The submitKey.

    • hasFeeScheduleKey

      boolean hasFeeScheduleKey()
       *
 Access control for update/delete of custom fees.
 <p>
 If this field is unset, the current custom fees CANNOT be changed.<br/>
 If this field is set, that `Key` MUST sign any transaction to update
 the custom fee schedule for this topic.
      .proto.Key fee_schedule_key = 11;
      Returns:
      Whether the feeScheduleKey field is set.

    • getFeeScheduleKey

      Key getFeeScheduleKey()
       *
 Access control for update/delete of custom fees.
 <p>
 If this field is unset, the current custom fees CANNOT be changed.<br/>
 If this field is set, that `Key` MUST sign any transaction to update
 the custom fee schedule for this topic.
      .proto.Key fee_schedule_key = 11;
      Returns:
      The feeScheduleKey.

    • getFeeExemptKeyListList

      List<Key> getFeeExemptKeyListList()
       *
 A set of "privileged payer" 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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.<br/>
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.<br/>
 A `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.
 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`.
      repeated .proto.Key fee_exempt_key_list = 12;

    • getFeeExemptKeyList

      Key getFeeExemptKeyList(int index)
       *
 A set of "privileged payer" 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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.<br/>
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.<br/>
 A `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.
 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`.
      repeated .proto.Key fee_exempt_key_list = 12;

    • getFeeExemptKeyListCount

      int getFeeExemptKeyListCount()
       *
 A set of "privileged payer" 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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 A `fee_exempt_key_list` MUST NOT contain more than
 `MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST` keys.<br/>
 A `fee_exempt_key_list` MUST NOT contain any duplicate keys.<br/>
 A `fee_exempt_key_list` MAY contain keys for accounts that are inactive,
 deleted, or non-existent.
 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`.
      repeated .proto.Key fee_exempt_key_list = 12;

    • getCustomFeesList

      List<FixedCustomFee> getCustomFeesList()
       *
 A set of custom fee definitions.<br/>
 These are fees to be assessed for each submit to this topic.
 <p>
 If this list is empty, the only fees charged for a submit to this
 topic SHALL be the network and node fees.<br/>
 If this list is not empty, 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/>
 If this list is not empty, custom fees defined here SHALL be
 charged _in addition to_ the base network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 13;

    • 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>
 If this list is empty, the only fees charged for a submit to this
 topic SHALL be the network and node fees.<br/>
 If this list is not empty, 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/>
 If this list is not empty, custom fees defined here SHALL be
 charged _in addition to_ the base network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 13;

    • getCustomFeesCount

      int getCustomFeesCount()
       *
 A set of custom fee definitions.<br/>
 These are fees to be assessed for each submit to this topic.
 <p>
 If this list is empty, the only fees charged for a submit to this
 topic SHALL be the network and node fees.<br/>
 If this list is not empty, 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/>
 If this list is not empty, custom fees defined here SHALL be
 charged _in addition to_ the base network and node fees.
      repeated .proto.FixedCustomFee custom_fees = 13;