org.hyperledger.fabric.protos.peer

Class StaticCollectionConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.hyperledger.fabric.protos.peer.StaticCollectionConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, StaticCollectionConfigOrBuilder

public final class StaticCollectionConfig
extends com.google.protobuf.GeneratedMessageV3
implements StaticCollectionConfigOrBuilder

 StaticCollectionConfig constitutes the configuration parameters of a
 static collection object. Static collections are collections that are
 known at chaincode instantiation time, and that cannot be changed.
 Dynamic collections are deferred.
 

Protobuf type protos.StaticCollectionConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticCollectionConfig.Builder StaticCollectionConfig constitutes the configuration parameters of a static collection object.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_TO_LIVE_FIELD_NUMBER
static int	ENDORSEMENT_POLICY_FIELD_NUMBER
static int	MAXIMUM_PEER_COUNT_FIELD_NUMBER
static int	MEMBER_ONLY_READ_FIELD_NUMBER
static int	MEMBER_ONLY_WRITE_FIELD_NUMBER
static int	MEMBER_ORGS_POLICY_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	REQUIRED_PEER_COUNT_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getBlockToLive() The number of blocks after which the collection data expires.
static StaticCollectionConfig	getDefaultInstance()
StaticCollectionConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ApplicationPolicy	getEndorsementPolicy() a reference to a policy residing / managed in the config block to define the endorsement policy for this collection
ApplicationPolicyOrBuilder	getEndorsementPolicyOrBuilder() a reference to a policy residing / managed in the config block to define the endorsement policy for this collection
int	getMaximumPeerCount() The maximum number of peers that private data will be sent to upon endorsement.
boolean	getMemberOnlyRead() 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)
boolean	getMemberOnlyWrite() 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)
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
CollectionPolicyConfigOrBuilder	getMemberOrgsPolicyOrBuilder() a reference to a policy residing / managed in the config block to define which orgs have access to this collection’s private data
String	getName() the name of the collection inside the denoted chaincode
com.google.protobuf.ByteString	getNameBytes() the name of the collection inside the denoted chaincode
com.google.protobuf.Parser<StaticCollectionConfig>	getParserForType()
int	getRequiredPeerCount() The minimum number of peers private data will be sent to upon endorsement.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndorsementPolicy() a reference to a policy residing / managed in the config block to define the endorsement policy for this collection
int	hashCode()
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
boolean	isInitialized()
static StaticCollectionConfig.Builder	newBuilder()
static StaticCollectionConfig.Builder	newBuilder(StaticCollectionConfig prototype)
StaticCollectionConfig.Builder	newBuilderForType()
static StaticCollectionConfig	parseDelimitedFrom(InputStream input)
static StaticCollectionConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticCollectionConfig	parseFrom(byte[] data)
static StaticCollectionConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticCollectionConfig	parseFrom(ByteBuffer data)
static StaticCollectionConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticCollectionConfig	parseFrom(com.google.protobuf.ByteString data)
static StaticCollectionConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticCollectionConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static StaticCollectionConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticCollectionConfig	parseFrom(InputStream input)
static StaticCollectionConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StaticCollectionConfig>	parser()
StaticCollectionConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

MEMBER_ORGS_POLICY_FIELD_NUMBER

public static final int MEMBER_ORGS_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRED_PEER_COUNT_FIELD_NUMBER

public static final int REQUIRED_PEER_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAXIMUM_PEER_COUNT_FIELD_NUMBER

public static final int MAXIMUM_PEER_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

BLOCK_TO_LIVE_FIELD_NUMBER

public static final int BLOCK_TO_LIVE_FIELD_NUMBER

See Also:

Constant Field Values

MEMBER_ONLY_READ_FIELD_NUMBER

public static final int MEMBER_ONLY_READ_FIELD_NUMBER

See Also:

Constant Field Values

MEMBER_ONLY_WRITE_FIELD_NUMBER

public static final int MEMBER_ONLY_WRITE_FIELD_NUMBER

See Also:

Constant Field Values

ENDORSEMENT_POLICY_FIELD_NUMBER

public static final int ENDORSEMENT_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

getName

public String getName()

 the name of the collection inside the denoted chaincode
 

string name = 1 [json_name = "name"];

Specified by:

getName in interface StaticCollectionConfigOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 the name of the collection inside the denoted chaincode
 

string name = 1 [json_name = "name"];

Specified by:

getNameBytes in interface StaticCollectionConfigOrBuilder

Returns:

The bytes for name.

hasMemberOrgsPolicy

public 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"];

Specified by:

hasMemberOrgsPolicy in interface StaticCollectionConfigOrBuilder

Returns:

Whether the memberOrgsPolicy field is set.

getMemberOrgsPolicy

public 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"];

Specified by:

getMemberOrgsPolicy in interface StaticCollectionConfigOrBuilder

Returns:

The memberOrgsPolicy.

getMemberOrgsPolicyOrBuilder

public CollectionPolicyConfigOrBuilder getMemberOrgsPolicyOrBuilder()

 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"];

Specified by:

getMemberOrgsPolicyOrBuilder in interface StaticCollectionConfigOrBuilder

getRequiredPeerCount

public int getRequiredPeerCount()

 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"];

Specified by:

getRequiredPeerCount in interface StaticCollectionConfigOrBuilder

Returns:

The requiredPeerCount.

getMaximumPeerCount

public int getMaximumPeerCount()

 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"];

Specified by:

getMaximumPeerCount in interface StaticCollectionConfigOrBuilder

Returns:

The maximumPeerCount.

getBlockToLive

public long getBlockToLive()

 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"];

Specified by:

getBlockToLive in interface StaticCollectionConfigOrBuilder

Returns:

The blockToLive.

getMemberOnlyRead

public boolean getMemberOnlyRead()

 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"];

Specified by:

getMemberOnlyRead in interface StaticCollectionConfigOrBuilder

Returns:

The memberOnlyRead.

getMemberOnlyWrite

public boolean getMemberOnlyWrite()

 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"];

Specified by:

getMemberOnlyWrite in interface StaticCollectionConfigOrBuilder

Returns:

The memberOnlyWrite.

hasEndorsementPolicy

public 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"];

Specified by:

hasEndorsementPolicy in interface StaticCollectionConfigOrBuilder

Returns:

Whether the endorsementPolicy field is set.

getEndorsementPolicy

public 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"];

Specified by:

getEndorsementPolicy in interface StaticCollectionConfigOrBuilder

Returns:

The endorsementPolicy.

getEndorsementPolicyOrBuilder

public ApplicationPolicyOrBuilder getEndorsementPolicyOrBuilder()

 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"];

Specified by:

getEndorsementPolicyOrBuilder in interface StaticCollectionConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StaticCollectionConfig parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticCollectionConfig parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static StaticCollectionConfig parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static StaticCollectionConfig parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static StaticCollectionConfig parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static StaticCollectionConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static StaticCollectionConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public StaticCollectionConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StaticCollectionConfig.Builder newBuilder()

newBuilder

public static StaticCollectionConfig.Builder newBuilder(StaticCollectionConfig prototype)

toBuilder

public StaticCollectionConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

getDefaultInstance

public static StaticCollectionConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<StaticCollectionConfig> parser()

getParserForType

public com.google.protobuf.Parser<StaticCollectionConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StaticCollectionConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder