com.daml.ledger.api.v1

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 Summary

Modifier and Type	Method and Description
boolean	containsEventsById(java.lang.String key) Changes to the ledger that were caused by this transaction.
java.lang.String	getCommandId() The ID of the command which resulted in this transaction.
com.google.protobuf.ByteString	getCommandIdBytes() The ID of the command which resulted in this transaction.
com.google.protobuf.Timestamp	getEffectiveAt() Ledger effective time.
com.google.protobuf.TimestampOrBuilder	getEffectiveAtOrBuilder() Ledger effective time.
java.util.Map<java.lang.String,TransactionOuterClass.TreeEvent>	getEventsById() Deprecated.
int	getEventsByIdCount() Changes to the ledger that were caused by this transaction.
java.util.Map<java.lang.String,TransactionOuterClass.TreeEvent>	getEventsByIdMap() Changes to the ledger that were caused by this transaction.
TransactionOuterClass.TreeEvent	getEventsByIdOrDefault(java.lang.String key, TransactionOuterClass.TreeEvent defaultValue) Changes to the ledger that were caused by this transaction.
TransactionOuterClass.TreeEvent	getEventsByIdOrThrow(java.lang.String key) Changes to the ledger that were caused by this transaction.
java.lang.String	getOffset() The absolute offset.
com.google.protobuf.ByteString	getOffsetBytes() The absolute offset.
java.lang.String	getRootEventIds(int index) Roots of the transaction tree.
com.google.protobuf.ByteString	getRootEventIdsBytes(int index) Roots of the transaction tree.
int	getRootEventIdsCount() Roots of the transaction tree.
java.util.List<java.lang.String>	getRootEventIdsList() Roots of the transaction tree.
TraceContextOuterClass.TraceContext	getTraceContext() Zipkin trace context.
TraceContextOuterClass.TraceContextOrBuilder	getTraceContextOrBuilder() Zipkin trace context.
java.lang.String	getTransactionId() Assigned by the server.
com.google.protobuf.ByteString	getTransactionIdBytes() Assigned by the server.
java.lang.String	getWorkflowId() The workflow ID used in command submission.
com.google.protobuf.ByteString	getWorkflowIdBytes() The workflow ID used in command submission.
boolean	hasEffectiveAt() Ledger effective time.
boolean	hasTraceContext() Zipkin trace context.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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"];

getEventsById

@Deprecated
java.util.Map<java.lang.String,TransactionOuterClass.TreeEvent> getEventsById()

Deprecated.

Use getEventsByIdMap() instead.

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 triggerd 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 triggerd 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 triggerd 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 triggerd 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()

 Zipkin trace context.
 This field is a future extension point and is currently not supported.
 Optional
 

.com.daml.ledger.api.v1.TraceContext trace_context = 1000[json_name = "traceContext"];

Returns:

Whether the traceContext field is set.

getTraceContext

TraceContextOuterClass.TraceContext getTraceContext()

 Zipkin trace context.
 This field is a future extension point and is currently not supported.
 Optional
 

.com.daml.ledger.api.v1.TraceContext trace_context = 1000[json_name = "traceContext"];

Returns:

The traceContext.

getTraceContextOrBuilder

TraceContextOuterClass.TraceContextOrBuilder getTraceContextOrBuilder()

 Zipkin trace context.
 This field is a future extension point and is currently not supported.
 Optional
 

.com.daml.ledger.api.v1.TraceContext trace_context = 1000[json_name = "traceContext"];