com.hederahashgraph.api.proto.java.TopicOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hedera-protobuf-java-api Show documentation
Hedera Protobuf Java API
There is a newer version: 0.57.1
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: state/consensus/topic.proto

package com.hederahashgraph.api.proto.java;

public interface TopicOrBuilder extends
    // @@protoc_insertion_point(interface_extends:proto.Topic)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * The topic's unique id in the Merkle state.
   * 
   *
   * .proto.TopicID topic_id = 1;
   * @return Whether the topicId field is set.
   */
  boolean hasTopicId();
  /**
   *    **
   * The topic's unique id in the Merkle state.
   * 
   *
   * .proto.TopicID topic_id = 1;
   * @return The topicId.
   */
  com.hederahashgraph.api.proto.java.TopicID getTopicId();
  /**
   *    **
   * The topic's unique id in the Merkle state.
   * 
   *
   * .proto.TopicID topic_id = 1;
   */
  com.hederahashgraph.api.proto.java.TopicIDOrBuilder getTopicIdOrBuilder();

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

  /**
   *    **
   * The topic's consensus expiration time in seconds since the epoch.
   * 
   *
   * int64 expiration_second = 3;
   * @return The expirationSecond.
   */
  long getExpirationSecond();

  /**
   *    **
   * 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;
   * @return The autoRenewPeriod.
   */
  long getAutoRenewPeriod();

  /**
   *    **
   * The id of the account (if any) that the network will attempt to charge for the
   * topic's auto-renewal upon expiration.
   * 
   *
   * .proto.AccountID auto_renew_account_id = 5;
   * @return Whether the autoRenewAccountId field is set.
   */
  boolean hasAutoRenewAccountId();
  /**
   *    **
   * The id of the account (if any) that the network will attempt to charge for the
   * topic's auto-renewal upon expiration.
   * 
   *
   * .proto.AccountID auto_renew_account_id = 5;
   * @return The autoRenewAccountId.
   */
  com.hederahashgraph.api.proto.java.AccountID getAutoRenewAccountId();
  /**
   *    **
   * The id of the account (if any) that the network will attempt to charge for the
   * topic's auto-renewal upon expiration.
   * 
   *
   * .proto.AccountID auto_renew_account_id = 5;
   */
  com.hederahashgraph.api.proto.java.AccountIDOrBuilder getAutoRenewAccountIdOrBuilder();

  /**
   *    **
   * Whether this topic is deleted.
   * 
   *
   * bool deleted = 6;
   * @return The deleted.
   */
  boolean getDeleted();

  /**
   *    **
   * 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 running_hash = 7;
   * @return The runningHash.
   */
  com.google.protobuf.ByteString getRunningHash();

  /**
   *    **
   * An optional description of the topic with UTF-8 encoding up to 100 bytes.
   * 
   *
   * string memo = 8;
   * @return The memo.
   */
  java.lang.String getMemo();
  /**
   *    **
   * An optional description of the topic with UTF-8 encoding up to 100 bytes.
   * 
   *
   * string memo = 8;
   * @return The bytes for memo.
   */
  com.google.protobuf.ByteString
      getMemoBytes();

  /**
   *    **
   * If present, enforces access control for updating or deleting the topic.
   * A topic without an admin key is immutable.
   * 
   *
   * .proto.Key admin_key = 9;
   * @return Whether the adminKey field is set.
   */
  boolean hasAdminKey();
  /**
   *    **
   * If present, enforces access control for updating or deleting the topic.
   * A topic without an admin key is immutable.
   * 
   *
   * .proto.Key admin_key = 9;
   * @return The adminKey.
   */
  com.hederahashgraph.api.proto.java.Key getAdminKey();
  /**
   *    **
   * If present, enforces access control for updating or deleting the topic.
   * A topic without an admin key is immutable.
   * 
   *
   * .proto.Key admin_key = 9;
   */
  com.hederahashgraph.api.proto.java.KeyOrBuilder getAdminKeyOrBuilder();

  /**
   *    **
   * If present, enforces access control for message submission to the topic.
   * 
   *
   * .proto.Key submit_key = 10;
   * @return Whether the submitKey field is set.
   */
  boolean hasSubmitKey();
  /**
   *    **
   * If present, enforces access control for message submission to the topic.
   * 
   *
   * .proto.Key submit_key = 10;
   * @return The submitKey.
   */
  com.hederahashgraph.api.proto.java.Key getSubmitKey();
  /**
   *    **
   * If present, enforces access control for message submission to the topic.
   * 
   *
   * .proto.Key submit_key = 10;
   */
  com.hederahashgraph.api.proto.java.KeyOrBuilder getSubmitKeyOrBuilder();
}