com.hedera.hashgraph.sdk.proto.ConsensusTopicInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-jdk7 Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: consensus_topic_info.proto

package com.hedera.hashgraph.sdk.proto;

public interface ConsensusTopicInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:proto.ConsensusTopicInfo)
    com.google.protobuf.MessageLiteOrBuilder {

  /**
   *    **
   * The memo associated with the topic (UTF-8 encoding max 100 bytes)
   * 
   *
   * string memo = 1;
   * @return The memo.
   */
  java.lang.String getMemo();
  /**
   *    **
   * The memo associated with the topic (UTF-8 encoding max 100 bytes)
   * 
   *
   * string memo = 1;
   * @return The bytes for memo.
   */
  com.google.protobuf.ByteString
      getMemoBytes();

  /**
   *    **
   * When a topic is created, its running hash is initialized to 48 bytes of binary zeros.
   * For each submitted message, the topic's running hash is then updated to the output
   * of a particular SHA-384 digest whose input data include the previous running hash.
   * 
   * See the TransactionReceipt.proto documentation for an exact description of the
   * data included in the SHA-384 digest used for the update.
   * 
   *
   * bytes runningHash = 2;
   * @return The runningHash.
   */
  com.google.protobuf.ByteString getRunningHash();

  /**
   *    **
   * Sequence number (starting at 1 for the first submitMessage) of messages on the topic.
   * 
   *
   * uint64 sequenceNumber = 3;
   * @return The sequenceNumber.
   */
  long getSequenceNumber();

  /**
   *    **
   * Effective consensus timestamp at (and after) which submitMessage calls will no longer succeed on the topic
   * and the topic will expire and after AUTORENEW_GRACE_PERIOD be automatically deleted.
   * 
   *
   * .proto.Timestamp expirationTime = 4;
   * @return Whether the expirationTime field is set.
   */
  boolean hasExpirationTime();
  /**
   *    **
   * Effective consensus timestamp at (and after) which submitMessage calls will no longer succeed on the topic
   * and the topic will expire and after AUTORENEW_GRACE_PERIOD be automatically deleted.
   * 
   *
   * .proto.Timestamp expirationTime = 4;
   * @return The expirationTime.
   */
  com.hedera.hashgraph.sdk.proto.Timestamp getExpirationTime();

  /**
   *    **
   * Access control for update/delete of the topic. Null if there is no key.
   * 
   *
   * .proto.Key adminKey = 5;
   * @return Whether the adminKey field is set.
   */
  boolean hasAdminKey();
  /**
   *    **
   * Access control for update/delete of the topic. Null if there is no key.
   * 
   *
   * .proto.Key adminKey = 5;
   * @return The adminKey.
   */
  com.hedera.hashgraph.sdk.proto.Key getAdminKey();

  /**
   *    **
   * Access control for ConsensusService.submitMessage. Null if there is no key.
   * 
   *
   * .proto.Key submitKey = 6;
   * @return Whether the submitKey field is set.
   */
  boolean hasSubmitKey();
  /**
   *    **
   * Access control for ConsensusService.submitMessage. Null if there is no key.
   * 
   *
   * .proto.Key submitKey = 6;
   * @return The submitKey.
   */
  com.hedera.hashgraph.sdk.proto.Key getSubmitKey();

  /**
   *    **
   * If an auto-renew account is specified, when the topic expires, its lifetime will be extended
   * by up to this duration (depending on the solvency of the auto-renew account). If the
   * auto-renew account has no funds at all, the topic will be deleted instead.
   * 
   *
   * .proto.Duration autoRenewPeriod = 7;
   * @return Whether the autoRenewPeriod field is set.
   */
  boolean hasAutoRenewPeriod();
  /**
   *    **
   * If an auto-renew account is specified, when the topic expires, its lifetime will be extended
   * by up to this duration (depending on the solvency of the auto-renew account). If the
   * auto-renew account has no funds at all, the topic will be deleted instead.
   * 
   *
   * .proto.Duration autoRenewPeriod = 7;
   * @return The autoRenewPeriod.
   */
  com.hedera.hashgraph.sdk.proto.Duration getAutoRenewPeriod();

  /**
   *    **
   * The account, if any, to charge for automatic renewal of the topic's lifetime upon expiry.
   * 
   *
   * .proto.AccountID autoRenewAccount = 8;
   * @return Whether the autoRenewAccount field is set.
   */
  boolean hasAutoRenewAccount();
  /**
   *    **
   * The account, if any, to charge for automatic renewal of the topic's lifetime upon expiry.
   * 
   *
   * .proto.AccountID autoRenewAccount = 8;
   * @return The autoRenewAccount.
   */
  com.hedera.hashgraph.sdk.proto.AccountID getAutoRenewAccount();

  /**
   *    **
   * The ledger ID the response was returned from; please see <a href="https://github.com/hashgraph/hedera-improvement-proposal/blob/master/HIP/hip-198.md">HIP-198</a> for the network-specific IDs. 
   * 
   *
   * bytes ledger_id = 9;
   * @return The ledgerId.
   */
  com.google.protobuf.ByteString getLedgerId();
}