package v0
- Alphabetic
- Public
- Protected
Type Members
- final case class AcknowledgeRequest(member: String, timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[AcknowledgeRequest] with Product with Serializable
- member
Who is the acknowledgement being sent on behalf of
- timestamp
The timestamp in sequencer time that they are acknowledging and will not re-read earlier events. It is expected that the caller has a received an event with this timestamp but this is not validated.
- Annotations
- @SerialVersionUID()
- final case class Authentication() extends GeneratedMessage with Updatable[Authentication] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class AwaitTimeRequest(domainId: Option[String], timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[AwaitTimeRequest] with Product with Serializable
- domainId
optional - must be specified for participants but can be defaulted for domain entities as they only have one possible domain
- timestamp
the domain time to wait for
- Annotations
- @SerialVersionUID()
- final case class Challenge() extends GeneratedMessage with Updatable[Challenge] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class FetchTimeRequest(domainId: Option[String], freshnessBound: Option[Duration]) extends GeneratedMessage with Updatable[FetchTimeRequest] with Product with Serializable
- domainId
optional - must be specified for participants but can be defaulted for domain entities as they only have one possible domain
- Annotations
- @SerialVersionUID()
- final case class FetchTimeResponse(timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[FetchTimeResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetServiceAgreementRequest() extends GeneratedMessage with Updatable[GetServiceAgreementRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetServiceAgreementResponse(agreement: Option[ServiceAgreement]) extends GeneratedMessage with Updatable[GetServiceAgreementResponse] with Product with Serializable
- agreement
Optional, present if the domain requires a service agreement
- Annotations
- @SerialVersionUID()
- final case class Hello() extends GeneratedMessage with Updatable[Hello] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class SendAsyncResponse(error: Option[Error]) extends GeneratedMessage with Updatable[SendAsyncResponse] with Product with Serializable
- error
Defined iff the response is an error.
- Annotations
- @SerialVersionUID()
- final case class SendAsyncSignedResponse(error: Option[Error]) extends GeneratedMessage with Updatable[SendAsyncSignedResponse] with Product with Serializable
Changes compared to SendAsyncResponse: added
Internal
andGeneric
.Changes compared to SendAsyncResponse: added
Internal
andGeneric
. Note:Generic
is not used yet, it is introduced for upgradability purposes.- error
Defined iff the response is an error.
- Annotations
- @SerialVersionUID()
- final case class SendAsyncUnauthenticatedVersionedRequest(submissionRequest: ByteString) extends GeneratedMessage with Updatable[SendAsyncUnauthenticatedVersionedRequest] with Product with Serializable
- submissionRequest
Contains a versioned SubmissionRequest of v0 or higher.
- Annotations
- @SerialVersionUID()
- final case class SendAsyncVersionedRequest(signedSubmissionRequest: ByteString) extends GeneratedMessage with Updatable[SendAsyncVersionedRequest] with Product with Serializable
- signedSubmissionRequest
Contains a versioned SignedContent of v0 or higher which itself contains a versioned SubmissionRequest of v0 or higher.
- Annotations
- @SerialVersionUID()
- final case class SequencedEventTrafficState(extraTrafficRemainder: Long, extraTrafficConsumed: Long) extends GeneratedMessage with Updatable[SequencedEventTrafficState] with Product with Serializable
- extraTrafficRemainder
Remaining extra traffic at the time of this event
- extraTrafficConsumed
Total extra traffic consumed at the time of this event
- Annotations
- @SerialVersionUID()
- sealed abstract class SequencerApiType extends GeneratedEnum
- final case class SequencerConnect() extends GeneratedMessage with Updatable[SequencerConnect] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class SequencerConnection(type: Type, alias: String) extends GeneratedMessage with Updatable[SequencerConnection] with Product with Serializable
Client configuration for how members should connect to the sequencer of a domain.
Client configuration for how members should connect to the sequencer of a domain.
- Annotations
- @SerialVersionUID()
- final case class SubscriptionRequest(member: String, counter: Long) extends GeneratedMessage with Updatable[SubscriptionRequest] with Product with Serializable
- counter
the counter indicates the next event to receive e.g. requesting events from 0 will send the first event (index 0) when it exists. a subscription request acts as an implicit ack for events with a lower counter value.
- Annotations
- @SerialVersionUID()
- final case class SubscriptionResponse(signedSequencedEvent: Option[SignedContent], traceContext: Option[TraceContext]) extends GeneratedMessage with Updatable[SubscriptionResponse] with Product with Serializable
- traceContext
optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body. optional, canton trace context
- Annotations
- @SerialVersionUID()
- final case class VersionedSubscriptionResponse(signedSequencedEvent: ByteString, traceContext: Option[TraceContext], trafficState: Option[SequencedEventTrafficState]) extends GeneratedMessage with Updatable[VersionedSubscriptionResponse] with Product with Serializable
- signedSequencedEvent
Contains a versioned SignedContent of v0 or higher
- traceContext
optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body. optional, canton trace context
- trafficState
Traffic state for the subscribed member Optional value which is set if the sequencer enforces traffic limits
- Annotations
- @SerialVersionUID()
Value Members
- object AcknowledgeRequest extends GeneratedMessageCompanion[AcknowledgeRequest] with StableProtoVersion
- object Authentication extends GeneratedMessageCompanion[Authentication]
- object AwaitTimeRequest extends GeneratedMessageCompanion[AwaitTimeRequest]
- object Challenge extends GeneratedMessageCompanion[Challenge]
- object DomainServiceProto extends GeneratedFileObject
- object DomainTimeServiceGrpc
- object DomainTimeServiceProto extends GeneratedFileObject
- object FetchTimeRequest extends GeneratedMessageCompanion[FetchTimeRequest]
- object FetchTimeResponse extends GeneratedMessageCompanion[FetchTimeResponse]
- object GetServiceAgreementRequest extends GeneratedMessageCompanion[GetServiceAgreementRequest]
- object GetServiceAgreementResponse extends GeneratedMessageCompanion[GetServiceAgreementResponse]
- object Hello extends GeneratedMessageCompanion[Hello]
- object HelloProto extends GeneratedFileObject
- object HelloServiceGrpc
- object SendAsyncResponse extends GeneratedMessageCompanion[SendAsyncResponse]
- object SendAsyncSignedResponse extends GeneratedMessageCompanion[SendAsyncSignedResponse]
- object SendAsyncUnauthenticatedVersionedRequest extends GeneratedMessageCompanion[SendAsyncUnauthenticatedVersionedRequest]
- object SendAsyncVersionedRequest extends GeneratedMessageCompanion[SendAsyncVersionedRequest]
- object SequencedEventTrafficState extends GeneratedMessageCompanion[SequencedEventTrafficState]
- object SequencerApiType extends GeneratedEnumCompanion[SequencerApiType]
- object SequencerAuthenticationServiceGrpc
- object SequencerAuthenticationServiceProto extends GeneratedFileObject
- object SequencerConnect extends GeneratedMessageCompanion[SequencerConnect]
- object SequencerConnectServiceGrpc
- object SequencerConnectServiceProto extends GeneratedFileObject
- object SequencerConnection extends GeneratedMessageCompanion[SequencerConnection] with StorageProtoVersion
- object SequencerConnectionProto extends GeneratedFileObject
- object SequencerServiceGrpc
- object SequencerServiceProto extends GeneratedFileObject
- object ServiceAgreementProto extends GeneratedFileObject
- object SubscriptionRequest extends GeneratedMessageCompanion[SubscriptionRequest] with StableProtoVersion
- object SubscriptionResponse extends GeneratedMessageCompanion[SubscriptionResponse]
- object VersionedSubscriptionResponse extends GeneratedMessageCompanion[VersionedSubscriptionResponse]
Deprecated Value Members
- object DomainServiceGrpc
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file