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

Interface ConsensusCreateTopicTransactionBodyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Key
    getAdminKey()
    * Access control for modification of the topic after it is created.
    AccountID
    getAutoRenewAccount()
    * The ID of the account to be charged renewal fees at the topic's expirationTime to extend the lifetime of the topic.
    Duration
    getAutoRenewPeriod()
    * The initial lifetime, in seconds, for the topic.<br/> This is also the number of seconds for which the topic SHALL 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.
    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 or delete of custom fees.
    String
    getMemo()
    * A short memo for this topic.
    com.google.protobuf.ByteString
    getMemoBytes()
    * A short memo for this topic.
    Key
    getSubmitKey()
    * Access control for message submission to the topic.
    boolean
    hasAdminKey()
    * Access control for modification of the topic after it is created.
    boolean
    hasAutoRenewAccount()
    * The ID of the account to be charged renewal fees at the topic's expirationTime to extend the lifetime of the topic.
    boolean
    hasAutoRenewPeriod()
    * The initial lifetime, in seconds, for the topic.<br/> This is also the number of seconds for which the topic SHALL be automatically renewed upon expiring, if it has a valid auto-renew account.
    boolean
    hasFeeScheduleKey()
    * Access control for update or delete of custom fees.
    boolean
    hasSubmitKey()
    * Access control for message submission to the topic.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getMemo

      String getMemo()
       *
 A short memo for 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 memo for 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.

    • hasAdminKey

      boolean hasAdminKey()
       *
 Access control for modification of the topic after it is created.
 <p>
 If this field is set, that key MUST sign this transaction.<br/>
 If this field is set, that key MUST sign each future transaction to
 update or delete the topic.<br/>
 An updateTopic transaction that _only_ extends the topic expirationTime
 (a "manual renewal" transaction) SHALL NOT require admin key
 signature.<br/>
 A topic without an admin key SHALL be immutable, except for expiration
 and renewal.<br/>
 If adminKey is not set, then `autoRenewAccount` SHALL NOT be set.
      .proto.Key adminKey = 2;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 Access control for modification of the topic after it is created.
 <p>
 If this field is set, that key MUST sign this transaction.<br/>
 If this field is set, that key MUST sign each future transaction to
 update or delete the topic.<br/>
 An updateTopic transaction that _only_ extends the topic expirationTime
 (a "manual renewal" transaction) SHALL NOT require admin key
 signature.<br/>
 A topic without an admin key SHALL be immutable, except for expiration
 and renewal.<br/>
 If adminKey is not set, then `autoRenewAccount` SHALL NOT be set.
      .proto.Key adminKey = 2;
      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.<br/>
 If this field is not set then any account may submit a message on the
 topic, without restriction.
      .proto.Key submitKey = 3;
      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.<br/>
 If this field is not set then any account may submit a message on the
 topic, without restriction.
      .proto.Key submitKey = 3;
      Returns:
      The submitKey.

    • hasAutoRenewPeriod

      boolean hasAutoRenewPeriod()
       *
 The initial lifetime, in seconds, for the topic.<br/>
 This is also the number of seconds for which the topic SHALL be
 automatically renewed upon expiring, if it has a valid auto-renew
 account.
 <p>
 This value MUST be set.<br/>
 This value MUST be greater than the configured
 MIN_AUTORENEW_PERIOD.<br/>
 This value MUST be less than the configured MAX_AUTORENEW_PERIOD.
      .proto.Duration autoRenewPeriod = 6;
      Returns:
      Whether the autoRenewPeriod field is set.

    • getAutoRenewPeriod

      Duration getAutoRenewPeriod()
       *
 The initial lifetime, in seconds, for the topic.<br/>
 This is also the number of seconds for which the topic SHALL be
 automatically renewed upon expiring, if it has a valid auto-renew
 account.
 <p>
 This value MUST be set.<br/>
 This value MUST be greater than the configured
 MIN_AUTORENEW_PERIOD.<br/>
 This value MUST be less than the configured MAX_AUTORENEW_PERIOD.
      .proto.Duration autoRenewPeriod = 6;
      Returns:
      The autoRenewPeriod.

    • hasAutoRenewAccount

      boolean hasAutoRenewAccount()
       *
 The ID of the account to be charged renewal fees at the topic's
 expirationTime to extend the lifetime of the topic.
 <p>
 The topic lifetime SHALL be extended by the smallest of the following:
 <ul>
 <li>The current `autoRenewPeriod` duration.</li>
 <li>The maximum duration that this account has funds to purchase.</li>
 <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic
 renewal.</li>
 </ul>
 If this value is set, the referenced account MUST sign this
 transaction.<br/>
 If this value is set, the `adminKey` field MUST also be set (though that
 key MAY not have any correlation to this account).
      .proto.AccountID autoRenewAccount = 7;
      Returns:
      Whether the autoRenewAccount field is set.

    • getAutoRenewAccount

      AccountID getAutoRenewAccount()
       *
 The ID of the account to be charged renewal fees at the topic's
 expirationTime to extend the lifetime of the topic.
 <p>
 The topic lifetime SHALL be extended by the smallest of the following:
 <ul>
 <li>The current `autoRenewPeriod` duration.</li>
 <li>The maximum duration that this account has funds to purchase.</li>
 <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic
 renewal.</li>
 </ul>
 If this value is set, the referenced account MUST sign this
 transaction.<br/>
 If this value is set, the `adminKey` field MUST also be set (though that
 key MAY not have any correlation to this account).
      .proto.AccountID autoRenewAccount = 7;
      Returns:
      The autoRenewAccount.

    • hasFeeScheduleKey

      boolean hasFeeScheduleKey()
       *
 Access control for update or delete of custom fees.
 <p>
 If set, subsequent `consensus_update_topic` transactions signed with this
 key MAY update or delete the custom fees for this topic.<br/>
 If not set, the custom fees for this topic SHALL BE immutable.<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 = 8;
      Returns:
      Whether the feeScheduleKey field is set.

    • getFeeScheduleKey

      Key getFeeScheduleKey()
       *
 Access control for update or delete of custom fees.
 <p>
 If set, subsequent `consensus_update_topic` transactions signed with this
 key MAY update or delete the custom fees for this topic.<br/>
 If not set, the custom fees for this topic SHALL BE immutable.<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 = 8;
      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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 This field MUST NOT contain more than 10 keys.<br/>
 fee_exempt_key_list SHALL NOT contain any duplicate keys.<br/>
 fee_exempt_key_list MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If fee_exempt_key_list is unset in this transaction, 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 = 9;

    • 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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 This field MUST NOT contain more than 10 keys.<br/>
 fee_exempt_key_list SHALL NOT contain any duplicate keys.<br/>
 fee_exempt_key_list MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If fee_exempt_key_list is unset in this transaction, 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 = 9;

    • 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 submit transaction is signed by _any_ key included in this set,
 custom fees SHALL NOT be charged for that transaction.<br/>
 This field MUST NOT contain more than 10 keys.<br/>
 fee_exempt_key_list SHALL NOT contain any duplicate keys.<br/>
 fee_exempt_key_list MAY contain keys for accounts that are inactive,
 deleted, or non-existent.<br/>
 If fee_exempt_key_list is unset in this transaction, 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 = 9;

    • 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.<br/>
 custom_fees list SHALL NOT contain more than
 `MAX_CUSTOM_FEE_ENTRIES_FOR_TOPICS` entries.
      repeated .proto.FixedCustomFee custom_fees = 10;

    • 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.<br/>
 custom_fees list SHALL NOT contain more than
 `MAX_CUSTOM_FEE_ENTRIES_FOR_TOPICS` entries.
      repeated .proto.FixedCustomFee custom_fees = 10;

    • 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.<br/>
 custom_fees list SHALL NOT contain more than
 `MAX_CUSTOM_FEE_ENTRIES_FOR_TOPICS` entries.
      repeated .proto.FixedCustomFee custom_fees = 10;