Package com.daml.ledger.api.v2

Class TransactionOuterClass.TransactionTree

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.TransactionOuterClass.TransactionTree
All Implemented Interfaces:
TransactionOuterClass.TransactionTreeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
TransactionOuterClass
public static final class TransactionOuterClass.TransactionTree extends com.google.protobuf.GeneratedMessageV3 implements TransactionOuterClass.TransactionTreeOrBuilder
 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Complete view of an on-ledger transaction.
Protobuf type com.daml.ledger.api.v2.TransactionTree
See Also:

  • Field Details

    • UPDATE_ID_FIELD_NUMBER

      public static final int UPDATE_ID_FIELD_NUMBER
      See Also:

    • COMMAND_ID_FIELD_NUMBER

      public static final int COMMAND_ID_FIELD_NUMBER
      See Also:

    • WORKFLOW_ID_FIELD_NUMBER

      public static final int WORKFLOW_ID_FIELD_NUMBER
      See Also:

    • EFFECTIVE_AT_FIELD_NUMBER

      public static final int EFFECTIVE_AT_FIELD_NUMBER
      See Also:

    • OFFSET_FIELD_NUMBER

      public static final int OFFSET_FIELD_NUMBER
      See Also:

    • EVENTS_BY_ID_FIELD_NUMBER

      public static final int EVENTS_BY_ID_FIELD_NUMBER
      See Also:

    • SYNCHRONIZER_ID_FIELD_NUMBER

      public static final int SYNCHRONIZER_ID_FIELD_NUMBER
      See Also:

    • TRACE_CONTEXT_FIELD_NUMBER

      public static final int TRACE_CONTEXT_FIELD_NUMBER
      See Also:

    • RECORD_TIME_FIELD_NUMBER

      public static final int RECORD_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getUpdateId

      public 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"];
      Specified by:
      getUpdateId in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The updateId.

    • getUpdateIdBytes

      public 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"];
      Specified by:
      getUpdateIdBytes in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The bytes for updateId.

    • getCommandId

      public 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"];
      Specified by:
      getCommandId in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The commandId.

    • getCommandIdBytes

      public 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"];
      Specified by:
      getCommandIdBytes in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The bytes for commandId.

    • getWorkflowId

      public 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"];
      Specified by:
      getWorkflowId in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      public 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"];
      Specified by:
      getWorkflowIdBytes in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The bytes for workflowId.

    • hasEffectiveAt

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

    • getEffectiveAt

      public com.google.protobuf.Timestamp getEffectiveAt()
       Ledger effective time.
 Required
      .google.protobuf.Timestamp effective_at = 4 [json_name = "effectiveAt"];
      Specified by:
      getEffectiveAt in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The effectiveAt.

    • getEffectiveAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEffectiveAtOrBuilder()
       Ledger effective time.
 Required
      .google.protobuf.Timestamp effective_at = 4 [json_name = "effectiveAt"];
      Specified by:
      getEffectiveAtOrBuilder in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getOffset

      public 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"];
      Specified by:
      getOffset in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The offset.

    • getEventsByIdCount

      public int getEventsByIdCount()
      Description copied from interface: TransactionOuterClass.TransactionTreeOrBuilder
       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"];
      Specified by:
      getEventsByIdCount in interface TransactionOuterClass.TransactionTreeOrBuilder

    • containsEventsById

      public 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"];
      Specified by:
      containsEventsById in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getEventsById

      @Deprecated public Map<Integer,TransactionOuterClass.TreeEvent> getEventsById()
      Deprecated.
      Use getEventsByIdMap() instead.
      Specified by:
      getEventsById in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getEventsByIdMap

      public 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"];
      Specified by:
      getEventsByIdMap in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getEventsByIdOrDefault

      public 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"];
      Specified by:
      getEventsByIdOrDefault in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getEventsByIdOrThrow

      public 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"];
      Specified by:
      getEventsByIdOrThrow in interface TransactionOuterClass.TransactionTreeOrBuilder

    • getSynchronizerId

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

    • getSynchronizerIdBytes

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

    • hasTraceContext

      public 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"];
      Specified by:
      hasTraceContext in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      Whether the traceContext field is set.

    • getTraceContext

      public 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"];
      Specified by:
      getTraceContext in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The traceContext.

    • getTraceContextOrBuilder

      public 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"];
      Specified by:
      getTraceContextOrBuilder in interface TransactionOuterClass.TransactionTreeOrBuilder

    • hasRecordTime

      public 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"];
      Specified by:
      hasRecordTime in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      Whether the recordTime field is set.

    • getRecordTime

      public 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"];
      Specified by:
      getRecordTime in interface TransactionOuterClass.TransactionTreeOrBuilder
      Returns:
      The recordTime.

    • getRecordTimeOrBuilder

      public 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"];
      Specified by:
      getRecordTimeOrBuilder in interface TransactionOuterClass.TransactionTreeOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransactionOuterClass.TransactionTree parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransactionOuterClass.TransactionTree parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOuterClass.TransactionTree parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransactionOuterClass.TransactionTree.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransactionOuterClass.TransactionTree.Builder newBuilder()

    • newBuilder

      public static TransactionOuterClass.TransactionTree.Builder newBuilder(TransactionOuterClass.TransactionTree prototype)

    • toBuilder

      public TransactionOuterClass.TransactionTree.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransactionOuterClass.TransactionTree.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static TransactionOuterClass.TransactionTree getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransactionOuterClass.TransactionTree> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransactionOuterClass.TransactionTree> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public TransactionOuterClass.TransactionTree getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder