org.hyperledger.fabric.protos.peer.StaticCollectionConfigOrBuilder Maven / Gradle / Ivy

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

package org.hyperledger.fabric.protos.peer;

public interface StaticCollectionConfigOrBuilder extends
    // @@protoc_insertion_point(interface_extends:protos.StaticCollectionConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * the name of the collection inside the denoted chaincode
   * 
   *
   * string name = 1 [json_name = "name"];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * the name of the collection inside the denoted chaincode
   * 
   *
   * string name = 1 [json_name = "name"];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * a reference to a policy residing / managed in the config block
   * to define which orgs have access to this collection’s private data
   * 
   *
   * .protos.CollectionPolicyConfig member_orgs_policy = 2 [json_name = "memberOrgsPolicy"];
   * @return Whether the memberOrgsPolicy field is set.
   */
  boolean hasMemberOrgsPolicy();
  /**
   *    * a reference to a policy residing / managed in the config block
   * to define which orgs have access to this collection’s private data
   * 
   *
   * .protos.CollectionPolicyConfig member_orgs_policy = 2 [json_name = "memberOrgsPolicy"];
   * @return The memberOrgsPolicy.
   */
  org.hyperledger.fabric.protos.peer.CollectionPolicyConfig getMemberOrgsPolicy();
  /**
   *    * a reference to a policy residing / managed in the config block
   * to define which orgs have access to this collection’s private data
   * 
   *
   * .protos.CollectionPolicyConfig member_orgs_policy = 2 [json_name = "memberOrgsPolicy"];
   */
  org.hyperledger.fabric.protos.peer.CollectionPolicyConfigOrBuilder getMemberOrgsPolicyOrBuilder();

  /**
   *    * The minimum number of peers private data will be sent to upon
   * endorsement. The endorsement would fail if dissemination to at least
   * this number of peers is not achieved.
   * 
   *
   * int32 required_peer_count = 3 [json_name = "requiredPeerCount"];
   * @return The requiredPeerCount.
   */
  int getRequiredPeerCount();

  /**
   *    * The maximum number of peers that private data will be sent to
   * upon endorsement. This number has to be bigger than required_peer_count.
   * 
   *
   * int32 maximum_peer_count = 4 [json_name = "maximumPeerCount"];
   * @return The maximumPeerCount.
   */
  int getMaximumPeerCount();

  /**
   *    * The number of blocks after which the collection data expires.
   * For instance if the value is set to 10, a key last modified by block number 100
   * will be purged at block number 111. A zero value is treated same as MaxUint64
   * 
   *
   * uint64 block_to_live = 5 [json_name = "blockToLive"];
   * @return The blockToLive.
   */
  long getBlockToLive();

  /**
   *    * The member only read access denotes whether only collection member clients
   * can read the private data (if set to true), or even non members can
   * read the data (if set to false, for example if you want to implement more granular
   * access logic in the chaincode)
   * 
   *
   * bool member_only_read = 6 [json_name = "memberOnlyRead"];
   * @return The memberOnlyRead.
   */
  boolean getMemberOnlyRead();

  /**
   *    * The member only write access denotes whether only collection member clients
   * can write the private data (if set to true), or even non members can
   * write the data (if set to false, for example if you want to implement more granular
   * access logic in the chaincode)
   * 
   *
   * bool member_only_write = 7 [json_name = "memberOnlyWrite"];
   * @return The memberOnlyWrite.
   */
  boolean getMemberOnlyWrite();

  /**
   *    * a reference to a policy residing / managed in the config block
   * to define the endorsement policy for this collection
   * 
   *
   * .protos.ApplicationPolicy endorsement_policy = 8 [json_name = "endorsementPolicy"];
   * @return Whether the endorsementPolicy field is set.
   */
  boolean hasEndorsementPolicy();
  /**
   *    * a reference to a policy residing / managed in the config block
   * to define the endorsement policy for this collection
   * 
   *
   * .protos.ApplicationPolicy endorsement_policy = 8 [json_name = "endorsementPolicy"];
   * @return The endorsementPolicy.
   */
  org.hyperledger.fabric.protos.peer.ApplicationPolicy getEndorsementPolicy();
  /**
   *    * a reference to a policy residing / managed in the config block
   * to define the endorsement policy for this collection
   * 
   *
   * .protos.ApplicationPolicy endorsement_policy = 8 [json_name = "endorsementPolicy"];
   */
  org.hyperledger.fabric.protos.peer.ApplicationPolicyOrBuilder getEndorsementPolicyOrBuilder();
}