org.hyperledger.fabric.protos.common

Class ChannelHeader.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

org.hyperledger.fabric.protos.common.ChannelHeader.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, ChannelHeaderOrBuilder

Enclosing class:

ChannelHeader

public static final class ChannelHeader.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>
implements ChannelHeaderOrBuilder

 Header is a generic replay prevention and identity message to include in a signed payload
 

Protobuf type common.ChannelHeader

Method Summary

Modifier and Type	Method and Description
ChannelHeader.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ChannelHeader	build()
ChannelHeader	buildPartial()
ChannelHeader.Builder	clear()
ChannelHeader.Builder	clearChannelId() Identifier of the channel this message is bound for
ChannelHeader.Builder	clearEpoch() The epoch in which this header was generated, where epoch is defined based on block height Epoch in which the response has been generated.
ChannelHeader.Builder	clearExtension() Extension that may be attached based on the header type
ChannelHeader.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ChannelHeader.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ChannelHeader.Builder	clearTimestamp() Timestamp is the local time when the message was created by the sender
ChannelHeader.Builder	clearTlsCertHash() If mutual TLS is employed, this represents the hash of the client's TLS certificate
ChannelHeader.Builder	clearTxId() An unique identifier that is used end-to-end.
ChannelHeader.Builder	clearType() Header types 0-10000 are reserved and defined by HeaderType
ChannelHeader.Builder	clearVersion() Version indicates message protocol version
ChannelHeader.Builder	clone()
String	getChannelId() Identifier of the channel this message is bound for
com.google.protobuf.ByteString	getChannelIdBytes() Identifier of the channel this message is bound for
ChannelHeader	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getEpoch() The epoch in which this header was generated, where epoch is defined based on block height Epoch in which the response has been generated.
com.google.protobuf.ByteString	getExtension() Extension that may be attached based on the header type
com.google.protobuf.Timestamp	getTimestamp() Timestamp is the local time when the message was created by the sender
com.google.protobuf.Timestamp.Builder	getTimestampBuilder() Timestamp is the local time when the message was created by the sender
com.google.protobuf.TimestampOrBuilder	getTimestampOrBuilder() Timestamp is the local time when the message was created by the sender
com.google.protobuf.ByteString	getTlsCertHash() If mutual TLS is employed, this represents the hash of the client's TLS certificate
String	getTxId() An unique identifier that is used end-to-end.
com.google.protobuf.ByteString	getTxIdBytes() An unique identifier that is used end-to-end.
int	getType() Header types 0-10000 are reserved and defined by HeaderType
int	getVersion() Version indicates message protocol version
boolean	hasTimestamp() Timestamp is the local time when the message was created by the sender
boolean	isInitialized()
ChannelHeader.Builder	mergeFrom(ChannelHeader other)
ChannelHeader.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ChannelHeader.Builder	mergeFrom(com.google.protobuf.Message other)
ChannelHeader.Builder	mergeTimestamp(com.google.protobuf.Timestamp value) Timestamp is the local time when the message was created by the sender
ChannelHeader.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ChannelHeader.Builder	setChannelId(String value) Identifier of the channel this message is bound for
ChannelHeader.Builder	setChannelIdBytes(com.google.protobuf.ByteString value) Identifier of the channel this message is bound for
ChannelHeader.Builder	setEpoch(long value) The epoch in which this header was generated, where epoch is defined based on block height Epoch in which the response has been generated.
ChannelHeader.Builder	setExtension(com.google.protobuf.ByteString value) Extension that may be attached based on the header type
ChannelHeader.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ChannelHeader.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ChannelHeader.Builder	setTimestamp(com.google.protobuf.Timestamp.Builder builderForValue) Timestamp is the local time when the message was created by the sender
ChannelHeader.Builder	setTimestamp(com.google.protobuf.Timestamp value) Timestamp is the local time when the message was created by the sender
ChannelHeader.Builder	setTlsCertHash(com.google.protobuf.ByteString value) If mutual TLS is employed, this represents the hash of the client's TLS certificate
ChannelHeader.Builder	setTxId(String value) An unique identifier that is used end-to-end.
ChannelHeader.Builder	setTxIdBytes(com.google.protobuf.ByteString value) An unique identifier that is used end-to-end.
ChannelHeader.Builder	setType(int value) Header types 0-10000 are reserved and defined by HeaderType
ChannelHeader.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ChannelHeader.Builder	setVersion(int value) Version indicates message protocol version

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

mergeFrom

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

clear

public ChannelHeader.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

getDefaultInstanceForType

public ChannelHeader getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ChannelHeader build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ChannelHeader buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ChannelHeader.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

setField

public ChannelHeader.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

clearField

public ChannelHeader.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

clearOneof

public ChannelHeader.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

setRepeatedField

public ChannelHeader.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

addRepeatedField

public ChannelHeader.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

mergeFrom

public ChannelHeader.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ChannelHeader.Builder>

mergeFrom

public ChannelHeader.Builder mergeFrom(ChannelHeader other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

mergeFrom

public ChannelHeader.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ChannelHeader.Builder>

Throws:

IOException

getType

public int getType()

 Header types 0-10000 are reserved and defined by HeaderType
 

int32 type = 1 [json_name = "type"];

Specified by:

getType in interface ChannelHeaderOrBuilder

Returns:

The type.

setType

public ChannelHeader.Builder setType(int value)

 Header types 0-10000 are reserved and defined by HeaderType
 

int32 type = 1 [json_name = "type"];

Parameters:

value - The type to set.

Returns:

This builder for chaining.

clearType

public ChannelHeader.Builder clearType()

 Header types 0-10000 are reserved and defined by HeaderType
 

int32 type = 1 [json_name = "type"];

Returns:

This builder for chaining.

getVersion

public int getVersion()

 Version indicates message protocol version
 

int32 version = 2 [json_name = "version"];

Specified by:

getVersion in interface ChannelHeaderOrBuilder

Returns:

The version.

setVersion

public ChannelHeader.Builder setVersion(int value)

 Version indicates message protocol version
 

int32 version = 2 [json_name = "version"];

Parameters:

value - The version to set.

Returns:

This builder for chaining.

clearVersion

public ChannelHeader.Builder clearVersion()

 Version indicates message protocol version
 

int32 version = 2 [json_name = "version"];

Returns:

This builder for chaining.

hasTimestamp

public boolean hasTimestamp()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

hasTimestamp in interface ChannelHeaderOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

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

Specified by:

getTimestamp in interface ChannelHeaderOrBuilder

Returns:

The timestamp.

setTimestamp

public ChannelHeader.Builder setTimestamp(com.google.protobuf.Timestamp value)

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

setTimestamp

public ChannelHeader.Builder setTimestamp(com.google.protobuf.Timestamp.Builder builderForValue)

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

mergeTimestamp

public ChannelHeader.Builder mergeTimestamp(com.google.protobuf.Timestamp value)

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

clearTimestamp

public ChannelHeader.Builder clearTimestamp()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

getTimestampBuilder

public com.google.protobuf.Timestamp.Builder getTimestampBuilder()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

getTimestampOrBuilder

public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()

 Timestamp is the local time when the message was created
 by the sender
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

getTimestampOrBuilder in interface ChannelHeaderOrBuilder

getChannelId

public String getChannelId()

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Specified by:

getChannelId in interface ChannelHeaderOrBuilder

Returns:

The channelId.

getChannelIdBytes

public com.google.protobuf.ByteString getChannelIdBytes()

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Specified by:

getChannelIdBytes in interface ChannelHeaderOrBuilder

Returns:

The bytes for channelId.

setChannelId

public ChannelHeader.Builder setChannelId(String value)

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Parameters:

value - The channelId to set.

Returns:

This builder for chaining.

clearChannelId

public ChannelHeader.Builder clearChannelId()

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Returns:

This builder for chaining.

setChannelIdBytes

public ChannelHeader.Builder setChannelIdBytes(com.google.protobuf.ByteString value)

 Identifier of the channel this message is bound for
 

string channel_id = 4 [json_name = "channelId"];

Parameters:

value - The bytes for channelId to set.

Returns:

This builder for chaining.

getTxId

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

Specified by:

getTxId in interface ChannelHeaderOrBuilder

Returns:

The txId.

getTxIdBytes

public com.google.protobuf.ByteString getTxIdBytes()

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

Specified by:

getTxIdBytes in interface ChannelHeaderOrBuilder

Returns:

The bytes for txId.

setTxId

public ChannelHeader.Builder setTxId(String value)

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

Parameters:

value - The txId to set.

Returns:

This builder for chaining.

clearTxId

public ChannelHeader.Builder clearTxId()

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

Returns:

This builder for chaining.

setTxIdBytes

public ChannelHeader.Builder setTxIdBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for txId to set.

Returns:

This builder for chaining.

getEpoch

public long getEpoch()

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

Specified by:

getEpoch in interface ChannelHeaderOrBuilder

Returns:

The epoch.

setEpoch

public ChannelHeader.Builder setEpoch(long value)

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

Parameters:

value - The epoch to set.

Returns:

This builder for chaining.

clearEpoch

public ChannelHeader.Builder clearEpoch()

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

Returns:

This builder for chaining.

getExtension

public com.google.protobuf.ByteString getExtension()

 Extension that may be attached based on the header type
 

bytes extension = 7 [json_name = "extension"];

Specified by:

getExtension in interface ChannelHeaderOrBuilder

Returns:

The extension.

setExtension

public ChannelHeader.Builder setExtension(com.google.protobuf.ByteString value)

 Extension that may be attached based on the header type
 

bytes extension = 7 [json_name = "extension"];

Parameters:

value - The extension to set.

Returns:

This builder for chaining.

clearExtension

public ChannelHeader.Builder clearExtension()

 Extension that may be attached based on the header type
 

bytes extension = 7 [json_name = "extension"];

Returns:

This builder for chaining.

getTlsCertHash

public com.google.protobuf.ByteString getTlsCertHash()

 If mutual TLS is employed, this represents
 the hash of the client's TLS certificate
 

bytes tls_cert_hash = 8 [json_name = "tlsCertHash"];

Specified by:

getTlsCertHash in interface ChannelHeaderOrBuilder

Returns:

The tlsCertHash.

setTlsCertHash

public ChannelHeader.Builder setTlsCertHash(com.google.protobuf.ByteString value)

 If mutual TLS is employed, this represents
 the hash of the client's TLS certificate
 

bytes tls_cert_hash = 8 [json_name = "tlsCertHash"];

Parameters:

value - The tlsCertHash to set.

Returns:

This builder for chaining.

clearTlsCertHash

public ChannelHeader.Builder clearTlsCertHash()

 If mutual TLS is employed, this represents
 the hash of the client's TLS certificate
 

bytes tls_cert_hash = 8 [json_name = "tlsCertHash"];

Returns:

This builder for chaining.

setUnknownFields

public final ChannelHeader.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>

mergeUnknownFields

public final ChannelHeader.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ChannelHeader.Builder>