CustodyOfferBatchRequest class

Available extensions

Constructors

CustodyOfferBatchRequest({int? protocolVersion, String? requestId, CustodyInlineOffers? inline, CustodySessionCandidate? sessionCandidate, String? baseHead, List<int>? evidencePack, String? observedHead, bool? fastForwardOnly, String? continuesAfter, bool? acknowledgeAdmission})
factory
CustodyOfferBatchRequest.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
CustodyOfferBatchRequest.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

acknowledgeAdmission ↔ bool
Set by the live link's relay (CAP-684): the custodian answers this batch with its admission as soon as it is judged, and sealed_main says how much of it is durable. Without it a custodian holds an admitted answer until its main is retained in custody (the HTTP lane). The sender keeps its recovery suffix above the sealed main, so a custodian that restarts without the unsealed admission is simply offered it again.
getter/setter pair
baseHead ↔ String
getter/setter pair
continuesAfter ↔ String
A streaming sender's batch continues its own previous batch, which ended at this commit and may not have been answered yet. The custodian admits it on its current main when the last offer it admitted from this session was exactly this commit and nothing else has moved its main since; otherwise base_head fences it as above. Offers stream out and admissions stream back, each in order, without a round trip per batch.
getter/setter pair
evidencePack ↔ List<int>
Inert, kernel-produced Git objects needed by commit-tree offers. Importing these bytes does not change refs or admit an offer.
getter/setter pair
fastForwardOnly ↔ bool
The sender already rebased these offers onto base_head in its own kernel and asks only for a fast-forward. When base_head is not this peer's admitted main, nothing is admitted: the response names the current main and the sender pulls, rebases locally and offers again. The merge happens on the peer that diverged, never on the custodian. Absent, the custodian re-admits the offers on its own tip as before (older senders).
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
inline ↔ CustodyInlineOffers
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
observedHead ↔ String
Sender's locally verified frontier. Equality needs no returned Git objects. base_head is the last common frontier for an incremental reconciliation.
getter/setter pair
protocolVersion ↔ int
getter/setter pair
requestId ↔ String
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionCandidate ↔ CustodySessionCandidate
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAcknowledgeAdmission() → void
clearBaseHead() → void
clearContinuesAfter() → void
clearEvidencePack() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFastForwardOnly() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearInline() → void
clearObservedHead() → void
clearProtocolVersion() → void
clearRequestId() → void
clearSessionCandidate() → void
clearSource() → void
clone() → CustodyOfferBatchRequest
Creates a deep copy of the fields in this message.
copyWith(void updates(CustodyOfferBatchRequest)) → CustodyOfferBatchRequest
Apply updates to a copy of this message.
createEmptyInstance() → CustodyOfferBatchRequest
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureInline() → CustodyInlineOffers
ensureSessionCandidate() → CustodySessionCandidate
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAcknowledgeAdmission() → bool
hasBaseHead() → bool
hasContinuesAfter() → bool
hasEvidencePack() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasFastForwardOnly() → bool
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasInline() → bool
hasObservedHead() → bool
hasProtocolVersion() → bool
hasRequestId() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSessionCandidate() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
whichSource() → CustodyOfferBatchRequest_Source
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited