Package com.daml.ledger.api.v2

Interface TransactionOuterClass.TransactionTreeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransactionOuterClass.TransactionTree, TransactionOuterClass.TransactionTree.Builder
Enclosing class:
TransactionOuterClass
public static interface TransactionOuterClass.TransactionTreeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getUpdateId

      String getUpdateId()
       Assigned by the server. Useful for correlating logs.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string update_id = 1 [json_name = "updateId"];
      Returns:
      The updateId.

    • getUpdateIdBytes

      com.google.protobuf.ByteString getUpdateIdBytes()
       Assigned by the server. Useful for correlating logs.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string update_id = 1 [json_name = "updateId"];
      Returns:
      The bytes for updateId.

    • getCommandId

      String getCommandId()
       The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string command_id = 2 [json_name = "commandId"];
      Returns:
      The commandId.

    • getCommandIdBytes

      com.google.protobuf.ByteString getCommandIdBytes()
       The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string command_id = 2 [json_name = "commandId"];
      Returns:
      The bytes for commandId.

    • getWorkflowId

      String getWorkflowId()
       The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string workflow_id = 3 [json_name = "workflowId"];
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      com.google.protobuf.ByteString getWorkflowIdBytes()
       The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string workflow_id = 3 [json_name = "workflowId"];
      Returns:
      The bytes for workflowId.

    • hasEffectiveAt

      boolean hasEffectiveAt()
       Ledger effective time.
 Required
      .google.protobuf.Timestamp effective_at = 4 [json_name = "effectiveAt"];
      Returns:
      Whether the effectiveAt field is set.

    • getEffectiveAt

      com.google.protobuf.Timestamp getEffectiveAt()
       Ledger effective time.
 Required
      .google.protobuf.Timestamp effective_at = 4 [json_name = "effectiveAt"];
      Returns:
      The effectiveAt.

    • getEffectiveAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getEffectiveAtOrBuilder()
       Ledger effective time.
 Required
      .google.protobuf.Timestamp effective_at = 4 [json_name = "effectiveAt"];

    • getOffset

      long getOffset()
       The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
 Required, it is a valid absolute offset (positive integer).
      int64 offset = 5 [json_name = "offset"];
      Returns:
      The offset.

    • getEventsByIdCount

      int getEventsByIdCount()
       Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key must be a valid node ID (non-negative integer).
 Required
      map<int32, .com.daml.ledger.api.v2.TreeEvent> events_by_id = 6 [json_name = "eventsById"];

    • containsEventsById

      boolean containsEventsById(int key)
       Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key must be a valid node ID (non-negative integer).
 Required
      map<int32, .com.daml.ledger.api.v2.TreeEvent> events_by_id = 6 [json_name = "eventsById"];

    • getEventsById

      @Deprecated Map<Integer,TransactionOuterClass.TreeEvent> getEventsById()
      Deprecated.
      Use getEventsByIdMap() instead.

    • getEventsByIdMap

      Map<Integer,TransactionOuterClass.TreeEvent> getEventsByIdMap()
       Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key must be a valid node ID (non-negative integer).
 Required
      map<int32, .com.daml.ledger.api.v2.TreeEvent> events_by_id = 6 [json_name = "eventsById"];

    • getEventsByIdOrDefault

      TransactionOuterClass.TreeEvent getEventsByIdOrDefault(int key, TransactionOuterClass.TreeEvent defaultValue)
       Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key must be a valid node ID (non-negative integer).
 Required
      map<int32, .com.daml.ledger.api.v2.TreeEvent> events_by_id = 6 [json_name = "eventsById"];

    • getEventsByIdOrThrow

      TransactionOuterClass.TreeEvent getEventsByIdOrThrow(int key)
       Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key must be a valid node ID (non-negative integer).
 Required
      map<int32, .com.daml.ledger.api.v2.TreeEvent> events_by_id = 6 [json_name = "eventsById"];

    • getSynchronizerId

      String getSynchronizerId()
       A valid synchronizer id.
 Identifies the synchronizer that synchronized the transaction.
 Required
      string synchronizer_id = 7 [json_name = "synchronizerId"];
      Returns:
      The synchronizerId.

    • getSynchronizerIdBytes

      com.google.protobuf.ByteString getSynchronizerIdBytes()
       A valid synchronizer id.
 Identifies the synchronizer that synchronized the transaction.
 Required
      string synchronizer_id = 7 [json_name = "synchronizerId"];
      Returns:
      The bytes for synchronizerId.

    • hasTraceContext

      boolean hasTraceContext()
       Optional; ledger API trace context

 The trace context transported in this message corresponds to the trace context supplied
 by the client application in a HTTP2 header of the original command submission.
 We typically use a header to transfer this type of information. Here we use message
 body, because it is used in gRPC streams which do not support per message headers.
 This field will be populated with the trace context contained in the original submission.
 If that was not provided, a unique ledger-api-server generated trace context will be used
 instead.
      .com.daml.ledger.api.v2.TraceContext trace_context = 8 [json_name = "traceContext"];
      Returns:
      Whether the traceContext field is set.

    • getTraceContext

      TraceContextOuterClass.TraceContext getTraceContext()
       Optional; ledger API trace context

 The trace context transported in this message corresponds to the trace context supplied
 by the client application in a HTTP2 header of the original command submission.
 We typically use a header to transfer this type of information. Here we use message
 body, because it is used in gRPC streams which do not support per message headers.
 This field will be populated with the trace context contained in the original submission.
 If that was not provided, a unique ledger-api-server generated trace context will be used
 instead.
      .com.daml.ledger.api.v2.TraceContext trace_context = 8 [json_name = "traceContext"];
      Returns:
      The traceContext.

    • getTraceContextOrBuilder

      TraceContextOuterClass.TraceContextOrBuilder getTraceContextOrBuilder()
       Optional; ledger API trace context

 The trace context transported in this message corresponds to the trace context supplied
 by the client application in a HTTP2 header of the original command submission.
 We typically use a header to transfer this type of information. Here we use message
 body, because it is used in gRPC streams which do not support per message headers.
 This field will be populated with the trace context contained in the original submission.
 If that was not provided, a unique ledger-api-server generated trace context will be used
 instead.
      .com.daml.ledger.api.v2.TraceContext trace_context = 8 [json_name = "traceContext"];

    • hasRecordTime

      boolean hasRecordTime()
       The time at which the transaction was recorded. The record time refers to the synchronizer
 which synchronized the transaction.
 Required
      .google.protobuf.Timestamp record_time = 9 [json_name = "recordTime"];
      Returns:
      Whether the recordTime field is set.

    • getRecordTime

      com.google.protobuf.Timestamp getRecordTime()
       The time at which the transaction was recorded. The record time refers to the synchronizer
 which synchronized the transaction.
 Required
      .google.protobuf.Timestamp record_time = 9 [json_name = "recordTime"];
      Returns:
      The recordTime.

    • getRecordTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getRecordTimeOrBuilder()
       The time at which the transaction was recorded. The record time refers to the synchronizer
 which synchronized the transaction.
 Required
      .google.protobuf.Timestamp record_time = 9 [json_name = "recordTime"];