package multidomain
- Alphabetic
- Public
- Protected
Type Members
- final case class Checkpoint(recordTime: Option[Timestamp], offset: Option[LedgerOffset]) extends GeneratedMessage with Updatable[Checkpoint] with Product with Serializable
Checkpoints may be used to:
Checkpoints may be used to:
* detect time out of commands. * provide an offset which can be used to restart consumption.
- recordTime
All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint. Required
- offset
May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Required
- Annotations
- @SerialVersionUID()
- final case class CompletionEndRequest(ledgerId: String, domainId: String) extends GeneratedMessage with Updatable[CompletionEndRequest] with Product with Serializable
- ledgerId
Must correspond to the ledger ID reported by the Ledger Identification Service. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- domainId
Must be a valid domain ID Required
- Annotations
- @SerialVersionUID()
- final case class CompletionEndResponse(offset: Option[LedgerOffset]) extends GeneratedMessage with Updatable[CompletionEndResponse] with Product with Serializable
- offset
This offset can be used in a CompletionStreamRequest message. Required
- Annotations
- @SerialVersionUID()
- final case class CompletionStreamRequest(ledgerId: String, applicationId: String, parties: Seq[String], offset: Option[LedgerOffset], domainId: String) extends GeneratedMessage with Updatable[CompletionStreamRequest] with Product with Serializable
- ledgerId
Must correspond to the ledger id reported by the Ledger Identification Service. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- applicationId
Only completions of commands submitted with the same application_id will be visible in the stream. Must be a valid ApplicationIdString (as described in
). Required unless authentication is used with a user token or a custom token specifying an application-id. In that case, the token's user-id, respectively application-id, will be used for the request's application_id.value.proto
- parties
Non-empty list of parties whose data should be included. Only completions of commands for which at least one of the
parties is in the given set of parties will be visible in the stream. Must be a valid PartyIdString (as described inact_as
). Requiredvalue.proto
- offset
This field indicates the minimum offset for completions. This can be used to resume an earlier completion stream. This offset is exclusive: the response will only contain commands whose offset is strictly greater than this. Optional, if not set the ledger uses the current ledger end offset instead.
- domainId
Must be a valid domain ID Required
- Annotations
- @SerialVersionUID()
- final case class CompletionStreamResponse(checkpoint: Option[Checkpoint], completions: Seq[Completion]) extends GeneratedMessage with Updatable[CompletionStreamResponse] with Product with Serializable
- checkpoint
This checkpoint may be used to restart consumption. The checkpoint is after any completions in this response. Optional
- completions
If set, one or more completions.
- Annotations
- @SerialVersionUID()
- final case class GetLedgerEndRequest(ledgerId: String, domainId: String) extends GeneratedMessage with Updatable[GetLedgerEndRequest] with Product with Serializable
- ledgerId
Must correspond to the ledger ID reported by the Ledger Identification Service. Must be a valid LedgerString (as describe in
). Optionalvalue.proto
- domainId
Must be a valid domain ID Required
- Annotations
- @SerialVersionUID()
- final case class GetLedgerEndResponse(offset: Option[LedgerOffset]) extends GeneratedMessage with Updatable[GetLedgerEndResponse] with Product with Serializable
- offset
The absolute offset of the current ledger end.
- Annotations
- @SerialVersionUID()
- final case class GetTreeUpdatesResponse(updates: Seq[TreeUpdate]) extends GeneratedMessage with Updatable[GetTreeUpdatesResponse] with Product with Serializable
- updates
The list of updates trees that matches the filter in the request.
- Annotations
- @SerialVersionUID()
- final case class GetUpdatesRequest(ledgerId: String, begin: Option[LedgerOffset], end: Option[LedgerOffset], party: String, domainId: String) extends GeneratedMessage with Updatable[GetUpdatesRequest] with Product with Serializable
- ledgerId
Must correspond to the ledger ID reported by the Ledger Identification Service. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- begin
Beginning of the requested ledger section. This offset is exclusive: the response will only contain transactions whose offset is strictly greater than this. Required
- end
End of the requested ledger section. This offset is inclusive: the response will only contain transactions whose offset is less than or equal to this. Optional, if not set, the stream will not terminate.
- party
Required For the multi-domain, this currently replace the usual TransactionFilter
- domainId
Must be a valid domain ID Required
- Annotations
- @SerialVersionUID()
- final case class Num(num: Long) extends GeneratedMessage with Updatable[Num] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class NumberRequest(from: Long) extends GeneratedMessage with Updatable[NumberRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class PingMessage(token: String, seqNum: Long) extends GeneratedMessage with Updatable[PingMessage] with Product with Serializable
- token
token to be echoed back in response
- seqNum
to be increased by one
- Annotations
- @SerialVersionUID()
- final case class SubmitRequest(transferCommand: Option[TransferCommand]) extends GeneratedMessage with Updatable[SubmitRequest] with Product with Serializable
- transferCommand
The transfer command to be submitted. Required
- Annotations
- @SerialVersionUID()
- final case class Transfer(updateId: String, commandId: String, workflowId: String, offset: String, submitter: String, event: Event) extends GeneratedMessage with Updatable[Transfer] with Product with Serializable
Complete view of an on-ledger transfer.
Complete view of an on-ledger transfer.
- updateId
Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in
). Requiredvalue.proto
- commandId
The ID of the command which resulted in this transfer. Missing for everyone except the submitting party on the submitting participant. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- workflowId
The workflow ID used in command submission. Only set if the
for the command was set. Must be a valid LedgerString (as described inworkflow_id
). Optionalvalue.proto
- offset
The absolute offset. The format of this field is described in
. Requiredledger_offset.proto
- submitter
Party on whose behalf the command was executed. Must be a valid PartyIdString (as described in
). Requiredvalue.proto
- Annotations
- @SerialVersionUID()
- final case class TransferCommand(ledgerId: String, workflowId: String, applicationId: String, commandId: String, submitter: String, command: Command, submissionId: String) extends GeneratedMessage with Updatable[TransferCommand] with Product with Serializable
- ledgerId
Must correspond to the ledger ID reported by the Ledger Identification Service. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- workflowId
Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in
). Optionalvalue.proto
- applicationId
Uniquely identifies the application or participant user that issued the command. Must be a valid ApplicationIdString (as described in
). Required unless authentication is used with a user token or a custom token specifying an application-id. In that case, the token's user-id, respectively application-id, will be used for the request's application_id.value.proto
- commandId
Uniquely identifies the command. The triple (application_id, submitter, command_id) constitutes the change ID for the intended ledger change. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in
). Requiredvalue.proto
- submitter
Party on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of the given party. Must be a valid PartyIdString (as described in
). Requiredvalue.proto
- submissionId
If omitted, the participant or the committer may set a value of their choice. Optional
- Annotations
- @SerialVersionUID()
- final case class TransferInCommand(transferOutId: String, source: String, target: String) extends GeneratedMessage with Updatable[TransferInCommand] with Product with Serializable
Transfer-in a contract
Transfer-in a contract
- transferOutId
The ID of the transfer-out event to be completed by this transfer-in. Must be a valid LedgerString (as described in
). Required TODO(#11002) currently, this is the ts.toMicros.toString of the transfer-out id re-evaluatevalue.proto
- source
The ID of the source domain Must be a valid domain ID Required
- target
The ID of the target domain Must be a valid domain ID Optional
- Annotations
- @SerialVersionUID()
- final case class TransferOutCommand(contractId: String, source: String, target: String) extends GeneratedMessage with Updatable[TransferOutCommand] with Product with Serializable
Transfer-out a contract
Transfer-out a contract
- contractId
The ID of the contract the client wants to transfer-out. Must be a valid LedgerString (as described in
). Requiredvalue.proto
- source
The ID of the source domain Must be a valid domain ID Optional
- target
The ID of the target domain Must be a valid domain ID Required
- Annotations
- @SerialVersionUID()
- final case class TransferredInEvent(source: String, target: String, transferOutId: String, createdEvent: Option[CreatedEvent]) extends GeneratedMessage with Updatable[TransferredInEvent] with Product with Serializable
Records that a contract has been transferred-in, and it becomes usable on the target domain
Records that a contract has been transferred-in, and it becomes usable on the target domain
- source
The ID of the source domain Must be a valid domain ID Required
- target
The ID of the target domain Must be a valid domain ID Required
- transferOutId
The ID of the transfer-out event For correlation capabilities Must be a valid LedgerString (as described in
). Requiredvalue.proto
- createdEvent
Required
- Annotations
- @SerialVersionUID()
- final case class TransferredOutEvent(transferOutId: String, contractId: String, source: String, target: String, transferInExclusivity: Option[Timestamp]) extends GeneratedMessage with Updatable[TransferredOutEvent] with Product with Serializable
Records that a contract has been transferred-out, and it becomes unusable on the source domain
Records that a contract has been transferred-out, and it becomes unusable on the source domain
- transferOutId
The ID of the transfer-out event. This needs to be used as an input for a transfer-in TransferCommand. Must be a valid LedgerString (as described in
). Required TODO(#11002) currently, this is the ts.toMicros.toString of the transfer-out id re-evaluatevalue.proto
- contractId
The ID of the transferred contract. Must be a valid LedgerString (as described in
). Requiredvalue.proto
- source
The ID of the source domain Must be a valid domain ID Required
- target
The ID of the target domain Must be a valid domain ID Required
- transferInExclusivity
Transfer-in exclusivity Before this time (measured on the target domain), only the submitter of the transfer-out can initiate the transfer-in Missing for everyone except on the submitting participant optional
- Annotations
- @SerialVersionUID()
- final case class TreeUpdate(treeUpdate: TreeUpdate.TreeUpdate) extends GeneratedMessage with Updatable[TreeUpdate] with Product with Serializable
- Annotations
- @SerialVersionUID()
Value Members
- object Checkpoint extends GeneratedMessageCompanion[Checkpoint]
- object CommandCompletionServiceGrpc
- object CommandCompletionServiceProto extends GeneratedFileObject
- object CompletionEndRequest extends GeneratedMessageCompanion[CompletionEndRequest]
- object CompletionEndResponse extends GeneratedMessageCompanion[CompletionEndResponse]
- object CompletionStreamRequest extends GeneratedMessageCompanion[CompletionStreamRequest]
- object CompletionStreamResponse extends GeneratedMessageCompanion[CompletionStreamResponse]
- object GetLedgerEndRequest extends GeneratedMessageCompanion[GetLedgerEndRequest]
- object GetLedgerEndResponse extends GeneratedMessageCompanion[GetLedgerEndResponse]
- object GetTreeUpdatesResponse extends GeneratedMessageCompanion[GetTreeUpdatesResponse]
- object GetUpdatesRequest extends GeneratedMessageCompanion[GetUpdatesRequest]
- object Num extends GeneratedMessageCompanion[Num]
- object NumberRequest extends GeneratedMessageCompanion[NumberRequest]
- object PingMessage extends GeneratedMessageCompanion[PingMessage]
- object SubmitRequest extends GeneratedMessageCompanion[SubmitRequest]
- object TestProto extends GeneratedFileObject
- object TestServiceGrpc
- object Transfer extends GeneratedMessageCompanion[Transfer]
- object TransferCommand extends GeneratedMessageCompanion[TransferCommand]
- object TransferCommandProto extends GeneratedFileObject
- object TransferInCommand extends GeneratedMessageCompanion[TransferInCommand]
- object TransferOutCommand extends GeneratedMessageCompanion[TransferOutCommand]
- object TransferProto extends GeneratedFileObject
- object TransferSubmissionServiceGrpc
- object TransferSubmissionServiceProto extends GeneratedFileObject
- object TransferredInEvent extends GeneratedMessageCompanion[TransferredInEvent]
- object TransferredOutEvent extends GeneratedMessageCompanion[TransferredOutEvent]
- object TreeUpdate extends GeneratedMessageCompanion[TreeUpdate]
- object UpdateServiceGrpc
- object UpdateServiceProto extends GeneratedFileObject