com.hedera.hapi.block.protoc.SubscribeStreamRequestOrBuilder 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: block_service.proto

package com.hedera.hapi.block.protoc;

public interface SubscribeStreamRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:com.hedera.hapi.block.SubscribeStreamRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * A block number to start the stream.
   * <p>
   * This SHALL be the block number of the first block returned.<br/>
   * This field MUST be less than or equal to the latest available
   * block number.
   * 
   *
   * uint64 start_block_number = 1;
   * @return The startBlockNumber.
   */
  long getStartBlockNumber();

  /**
   *    **
   * A block number to end the stream.<br/>
   * This is optional, and if not set (0), the stream will be "infinite".
   * <p>
   * This field MAY be zero (`0`) to indicate the stream SHOULD continue
   * indefinitely, streaming new blocks as each becomes available.<br/>
   * If this value is greater than zero (`0`)
   * <ul>
   *   <li>This value SHALL be the number of the last block returned.</li>
   *   <li>This field MUST NOT be less than `start_block_number`.</li>
   *   <li>This SHOULD be a block number that is immediately available
   *       from the block node.</li>
   *   <li>A block node SHALL continue to stream blocks until the last
   *       requested block is transmitted.</li>
   *   <li>A block node implementation MAY reject a request for a block
   *       that is not yet available.</li>
   *   <li>A block node implementation MAY accept future block numbers.</li>
   *   <li>Block node implementations MAY charge increased fees for such
   *       "future" streams.</li>
   * </ul>
   * 
   *
   * uint64 end_block_number = 2;
   * @return The endBlockNumber.
   */
  long getEndBlockNumber();

  /**
   *    **
   * A flag to indicate that the requested block(s) may be sent before
   * verifying each block's `BlockProof`.<br/>
   * This might be set by a client that expects to perform its own
   * verification and wishes lower latency or, potentially, lower cost.
   * <p>
   * If this value is set, then the responding Block Node MAY respond with
   * blocks that have not (yet) completed block proof verification.<br/>
   * If this is _not set_ then the Block Node MUST respond with only
   * fully verified and validated block(s).<br/>
   * If this is _set_, then a Block Node MAY stream items from
   * blocks that have not yet been verified or do not yet have
   * a block proof available.<br/>
   * The default value is _not set_.
   * 
   *
   * bool allow_unverified = 3;
   * @return The allowUnverified.
   */
  boolean getAllowUnverified();
}