org.hyperledger.fabric.protos.common.ChannelHeaderOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// NO CHECKED-IN PROTOBUF GENCODE
// source: common/common.proto
// Protobuf Java Version: 4.28.2

package org.hyperledger.fabric.protos.common;

public interface ChannelHeaderOrBuilder extends
    // @@protoc_insertion_point(interface_extends:common.ChannelHeader)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Header types 0-10000 are reserved and defined by HeaderType
   * 
   *
   * int32 type = 1 [json_name = "type"];
   * @return The type.
   */
  int getType();

  /**
   *    * Version indicates message protocol version
   * 
   *
   * int32 version = 2 [json_name = "version"];
   * @return The version.
   */
  int getVersion();

  /**
   *    * Timestamp is the local time when the message was created
   * by the sender
   * 
   *
   * .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
   * @return Whether the timestamp field is set.
   */
  boolean hasTimestamp();
  /**
   *    * Timestamp is the local time when the message was created
   * by the sender
   * 
   *
   * .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
   * @return The timestamp.
   */
  com.google.protobuf.Timestamp getTimestamp();
  /**
   *    * Timestamp is the local time when the message was created
   * by the sender
   * 
   *
   * .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
   */
  com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder();

  /**
   *    * Identifier of the channel this message is bound for
   * 
   *
   * string channel_id = 4 [json_name = "channelId"];
   * @return The channelId.
   */
  java.lang.String getChannelId();
  /**
   *    * Identifier of the channel this message is bound for
   * 
   *
   * string channel_id = 4 [json_name = "channelId"];
   * @return The bytes for channelId.
   */
  com.google.protobuf.ByteString
      getChannelIdBytes();

  /**
   *    * An unique identifier that is used end-to-end.
   * -  set by higher layers such as end user or SDK
   * -  passed to the endorser (which will check for uniqueness)
   * -  as the header is passed along unchanged, it will be
   * be retrieved by the committer (uniqueness check here as well)
   * -  to be stored in the ledger
   * 
   *
   * string tx_id = 5 [json_name = "txId"];
   * @return The txId.
   */
  java.lang.String getTxId();
  /**
   *    * An unique identifier that is used end-to-end.
   * -  set by higher layers such as end user or SDK
   * -  passed to the endorser (which will check for uniqueness)
   * -  as the header is passed along unchanged, it will be
   * be retrieved by the committer (uniqueness check here as well)
   * -  to be stored in the ledger
   * 
   *
   * string tx_id = 5 [json_name = "txId"];
   * @return The bytes for txId.
   */
  com.google.protobuf.ByteString
      getTxIdBytes();

  /**
   *    * The epoch in which this header was generated, where epoch is defined based on block height
   * Epoch in which the response has been generated. This field identifies a
   * logical window of time. A proposal response is accepted by a peer only if
   * two conditions hold:
   * 1. the epoch specified in the message is the current epoch
   * 2. this message has been only seen once during this epoch (i.e. it hasn't
   * been replayed)
   * 
   *
   * uint64 epoch = 6 [json_name = "epoch"];
   * @return The epoch.
   */
  long getEpoch();

  /**
   *    * Extension that may be attached based on the header type
   * 
   *
   * bytes extension = 7 [json_name = "extension"];
   * @return The extension.
   */
  com.google.protobuf.ByteString getExtension();

  /**
   *    * If mutual TLS is employed, this represents
   * the hash of the client's TLS certificate
   * 
   *
   * bytes tls_cert_hash = 8 [json_name = "tlsCertHash"];
   * @return The tlsCertHash.
   */
  com.google.protobuf.ByteString getTlsCertHash();
}