com.daml.ledger.api.v1

Interface TransactionServiceOuterClass.GetTransactionsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransactionServiceOuterClass.GetTransactionsRequest, TransactionServiceOuterClass.GetTransactionsRequest.Builder

Enclosing class:

TransactionServiceOuterClass

public static interface TransactionServiceOuterClass.GetTransactionsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
LedgerOffsetOuterClass.LedgerOffset	getBegin() Beginning of the requested ledger section.
LedgerOffsetOuterClass.LedgerOffsetOrBuilder	getBeginOrBuilder() Beginning of the requested ledger section.
LedgerOffsetOuterClass.LedgerOffset	getEnd() End of the requested ledger section.
LedgerOffsetOuterClass.LedgerOffsetOrBuilder	getEndOrBuilder() End of the requested ledger section.
TransactionFilterOuterClass.TransactionFilter	getFilter() Requesting parties with template filters.
TransactionFilterOuterClass.TransactionFilterOrBuilder	getFilterOrBuilder() Requesting parties with template filters.
java.lang.String	getLedgerId() Must correspond to the ledger ID reported by the Ledger Identification Service.
com.google.protobuf.ByteString	getLedgerIdBytes() Must correspond to the ledger ID reported by the Ledger Identification Service.
TraceContextOuterClass.TraceContext	getTraceContext() Server side tracing will be registered as a child of the submitted context.
TraceContextOuterClass.TraceContextOrBuilder	getTraceContextOrBuilder() Server side tracing will be registered as a child of the submitted context.
boolean	getVerbose() If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
boolean	hasBegin() Beginning of the requested ledger section.
boolean	hasEnd() End of the requested ledger section.
boolean	hasFilter() Requesting parties with template filters.
boolean	hasTraceContext() Server side tracing will be registered as a child of the submitted 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

getLedgerId

java.lang.String getLedgerId()

 Must correspond to the ledger ID reported by the Ledger Identification Service.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
 

string ledger_id = 1 [json_name = "ledgerId"];

Returns:

The ledgerId.

getLedgerIdBytes

com.google.protobuf.ByteString getLedgerIdBytes()

 Must correspond to the ledger ID reported by the Ledger Identification Service.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
 

string ledger_id = 1 [json_name = "ledgerId"];

Returns:

The bytes for ledgerId.

hasBegin

boolean hasBegin()

 Beginning of the requested ledger section.
 This offset is exclusive: the response will only contain transactions whose offset is strictly greater than this.
 Required
 

.com.daml.ledger.api.v1.LedgerOffset begin = 2 [json_name = "begin"];

Returns:

Whether the begin field is set.

getBegin

LedgerOffsetOuterClass.LedgerOffset getBegin()

 Beginning of the requested ledger section.
 This offset is exclusive: the response will only contain transactions whose offset is strictly greater than this.
 Required
 

.com.daml.ledger.api.v1.LedgerOffset begin = 2 [json_name = "begin"];

Returns:

The begin.

getBeginOrBuilder

LedgerOffsetOuterClass.LedgerOffsetOrBuilder getBeginOrBuilder()

 Beginning of the requested ledger section.
 This offset is exclusive: the response will only contain transactions whose offset is strictly greater than this.
 Required
 

.com.daml.ledger.api.v1.LedgerOffset begin = 2 [json_name = "begin"];

hasEnd

boolean hasEnd()

 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.
 

.com.daml.ledger.api.v1.LedgerOffset end = 3 [json_name = "end"];

Returns:

Whether the end field is set.

getEnd

LedgerOffsetOuterClass.LedgerOffset getEnd()

 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.
 

.com.daml.ledger.api.v1.LedgerOffset end = 3 [json_name = "end"];

Returns:

The end.

getEndOrBuilder

LedgerOffsetOuterClass.LedgerOffsetOrBuilder getEndOrBuilder()

 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.
 

.com.daml.ledger.api.v1.LedgerOffset end = 3 [json_name = "end"];

hasFilter

boolean hasFilter()

 Requesting parties with template filters.
 Template filters must be empty for GetTransactionTrees requests.
 Required
 

.com.daml.ledger.api.v1.TransactionFilter filter = 4 [json_name = "filter"];

Returns:

Whether the filter field is set.

getFilter

TransactionFilterOuterClass.TransactionFilter getFilter()

 Requesting parties with template filters.
 Template filters must be empty for GetTransactionTrees requests.
 Required
 

.com.daml.ledger.api.v1.TransactionFilter filter = 4 [json_name = "filter"];

Returns:

The filter.

getFilterOrBuilder

TransactionFilterOuterClass.TransactionFilterOrBuilder getFilterOrBuilder()

 Requesting parties with template filters.
 Template filters must be empty for GetTransactionTrees requests.
 Required
 

.com.daml.ledger.api.v1.TransactionFilter filter = 4 [json_name = "filter"];

getVerbose

boolean getVerbose()

 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
 Optional
 

bool verbose = 5 [json_name = "verbose"];

Returns:

The verbose.

hasTraceContext

boolean hasTraceContext()

 Server side tracing will be registered as a child of the submitted 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()

 Server side tracing will be registered as a child of the submitted 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()

 Server side tracing will be registered as a child of the submitted 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"];