Type Members

1.  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()

2.  final case class Authentication() extends GeneratedMessage with Updatable[Authentication] with Product with Serializable

   Annotations

   @SerialVersionUID()

3.  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()

4.  final case class Challenge() extends GeneratedMessage with Updatable[Challenge] with Product with Serializable

   Annotations

   @SerialVersionUID()

5.  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()

6.  final case class FetchTimeResponse(timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[FetchTimeResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

7.  final case class GetServiceAgreementRequest() extends GeneratedMessage with Updatable[GetServiceAgreementRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

8.  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()

9.  final case class Hello() extends GeneratedMessage with Updatable[Hello] with Product with Serializable

   Annotations

   @SerialVersionUID()

10.  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()

11.  final case class SendAsyncSignedResponse(error: Option[Error]) extends GeneratedMessage with Updatable[SendAsyncSignedResponse] with Product with Serializable

    Changes compared to SendAsyncResponse: added Internal and Generic.

    Changes compared to SendAsyncResponse: added Internal and Generic. Note: Generic is not used yet, it is introduced for upgradability purposes.

    error

    Defined iff the response is an error.

    Annotations

    @SerialVersionUID()

12.  sealed abstract class SequencerApiType extends GeneratedEnum
13.  final case class SequencerConnect() extends GeneratedMessage with Updatable[SequencerConnect] with Product with Serializable

    Annotations

    @SerialVersionUID()

14.  final case class SequencerConnection(type: Type) 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()

15.  final case class SubmissionRequest(sender: String, messageId: String, isRequest: Boolean, batch: Option[CompressedBatch], maxSequencingTime: Option[Timestamp], timestampOfSigningKey: Option[Timestamp]) extends GeneratedMessage with Updatable[SubmissionRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

16.  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()

17.  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()