Package com.daml.ledger.api.v1

Interface TransactionOuterClass.TransactionTreeOrBuilder

    • Method Detail

      • getTransactionId

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

      • getTransactionIdBytes

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

      • getCommandId

        java.lang.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

        java.lang.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

        java.lang.String getOffset()
         The absolute offset. The format of this field is described in ``ledger_offset.proto``.
 Required
        string offset = 6 [json_name = "offset"];
        Returns:
        The offset.

      • getOffsetBytes

        com.google.protobuf.ByteString getOffsetBytes()
         The absolute offset. The format of this field is described in ``ledger_offset.proto``.
 Required
        string offset = 6 [json_name = "offset"];
        Returns:
        The bytes for offset.

      • getEventsByIdCount

        int getEventsByIdCount()
         Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key be a valid LedgerString (as describe in ``value.proto``).
 Required
        map<string, .com.daml.ledger.api.v1.TreeEvent> events_by_id = 7 [json_name = "eventsById"];

      • containsEventsById

        boolean containsEventsById​(java.lang.String key)
         Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key be a valid LedgerString (as describe in ``value.proto``).
 Required
        map<string, .com.daml.ledger.api.v1.TreeEvent> events_by_id = 7 [json_name = "eventsById"];

      • getEventsByIdMap

        java.util.Map<java.lang.String,​TransactionOuterClass.TreeEvent> getEventsByIdMap()
         Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key be a valid LedgerString (as describe in ``value.proto``).
 Required
        map<string, .com.daml.ledger.api.v1.TreeEvent> events_by_id = 7 [json_name = "eventsById"];

      • getEventsByIdOrDefault

        TransactionOuterClass.TreeEvent getEventsByIdOrDefault​(java.lang.String key,
                                                       TransactionOuterClass.TreeEvent defaultValue)
         Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key be a valid LedgerString (as describe in ``value.proto``).
 Required
        map<string, .com.daml.ledger.api.v1.TreeEvent> events_by_id = 7 [json_name = "eventsById"];

      • getEventsByIdOrThrow

        TransactionOuterClass.TreeEvent getEventsByIdOrThrow​(java.lang.String key)
         Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
 Each key be a valid LedgerString (as describe in ``value.proto``).
 Required
        map<string, .com.daml.ledger.api.v1.TreeEvent> events_by_id = 7 [json_name = "eventsById"];

      • getRootEventIdsList

        java.util.List<java.lang.String> getRootEventIdsList()
         Roots of the transaction tree.
 Each element must be a valid LedgerString (as describe in ``value.proto``).
 The elements are in the same order as the commands in the
 corresponding Commands object that triggered this transaction.
 Required
        repeated string root_event_ids = 8 [json_name = "rootEventIds"];
        Returns:
        A list containing the rootEventIds.

      • getRootEventIdsCount

        int getRootEventIdsCount()
         Roots of the transaction tree.
 Each element must be a valid LedgerString (as describe in ``value.proto``).
 The elements are in the same order as the commands in the
 corresponding Commands object that triggered this transaction.
 Required
        repeated string root_event_ids = 8 [json_name = "rootEventIds"];
        Returns:
        The count of rootEventIds.

      • getRootEventIds

        java.lang.String getRootEventIds​(int index)
         Roots of the transaction tree.
 Each element must be a valid LedgerString (as describe in ``value.proto``).
 The elements are in the same order as the commands in the
 corresponding Commands object that triggered this transaction.
 Required
        repeated string root_event_ids = 8 [json_name = "rootEventIds"];
        Parameters:
        index - The index of the element to return.
        Returns:
        The rootEventIds at the given index.

      • getRootEventIdsBytes

        com.google.protobuf.ByteString getRootEventIdsBytes​(int index)
         Roots of the transaction tree.
 Each element must be a valid LedgerString (as describe in ``value.proto``).
 The elements are in the same order as the commands in the
 corresponding Commands object that triggered this transaction.
 Required
        repeated string root_event_ids = 8 [json_name = "rootEventIds"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the rootEventIds at the given index.

      • 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.v1.TraceContext trace_context = 9 [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.v1.TraceContext trace_context = 9 [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.v1.TraceContext trace_context = 9 [json_name = "traceContext"];