Package com.daml.ledger.api.v2

Interface CompletionOuterClass.CompletionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CompletionOuterClass.Completion, CompletionOuterClass.Completion.Builder
Enclosing class:
CompletionOuterClass
public static interface CompletionOuterClass.CompletionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getActAs(int index)
    The set of parties on whose behalf the commands were executed.
    com.google.protobuf.ByteString
    getActAsBytes(int index)
    The set of parties on whose behalf the commands were executed.
    int
    getActAsCount()
    The set of parties on whose behalf the commands were executed.
    List<String>
    getActAsList()
    The set of parties on whose behalf the commands were executed.
    String
    getCommandId()
    The ID of the succeeded or failed command.
    com.google.protobuf.ByteString
    getCommandIdBytes()
    The ID of the succeeded or failed command.
    com.google.protobuf.Duration
    getDeduplicationDuration()
    Specifies the length of the deduplication period.
    com.google.protobuf.DurationOrBuilder
    getDeduplicationDurationOrBuilder()
    Specifies the length of the deduplication period.
    long
    getDeduplicationOffset()
    Specifies the start of the deduplication period by a completion stream offset (exclusive).
    CompletionOuterClass.Completion.DeduplicationPeriodCase
    getDeduplicationPeriodCase()
     
    long
    getOffset()
    May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.
    long
    getPaidTrafficCost()
    The traffic cost paid by this participant node for the confirmation request for the submitted command.
    com.google.rpc.Status
    getStatus()
    Identifies the exact type of the error.
    com.google.rpc.StatusOrBuilder
    getStatusOrBuilder()
    Identifies the exact type of the error.
    String
    getSubmissionId()
    The submission ID this completion refers to, as described in ``commands.proto``.
    com.google.protobuf.ByteString
    getSubmissionIdBytes()
    The submission ID this completion refers to, as described in ``commands.proto``.
    OffsetCheckpointOuterClass.SynchronizerTime
    getSynchronizerTime()
    The synchronizer along with its record time.
    OffsetCheckpointOuterClass.SynchronizerTimeOrBuilder
    getSynchronizerTimeOrBuilder()
    The synchronizer along with its record time.
    TraceContextOuterClass.TraceContext
    getTraceContext()
    The 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.
    TraceContextOuterClass.TraceContextOrBuilder
    getTraceContextOrBuilder()
    The 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.
    String
    getUpdateId()
    The update_id of the transaction or reassignment that resulted from the command with command_id.
    com.google.protobuf.ByteString
    getUpdateIdBytes()
    The update_id of the transaction or reassignment that resulted from the command with command_id.
    String
    getUserId()
    The user-id that was used for the submission, as described in ``commands.proto``.
    com.google.protobuf.ByteString
    getUserIdBytes()
    The user-id that was used for the submission, as described in ``commands.proto``.
    boolean
    hasDeduplicationDuration()
    Specifies the length of the deduplication period.
    boolean
    hasDeduplicationOffset()
    Specifies the start of the deduplication period by a completion stream offset (exclusive).
    boolean
    hasStatus()
    Identifies the exact type of the error.
    boolean
    hasSynchronizerTime()
    The synchronizer along with its record time.
    boolean
    hasTraceContext()
    The 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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getCommandId

      String getCommandId()
       The ID of the succeeded or failed command.
 Must be a valid LedgerString (as described in ``value.proto``).

 Required
      string command_id = 1;
      Returns:
      The commandId.

    • getCommandIdBytes

      com.google.protobuf.ByteString getCommandIdBytes()
       The ID of the succeeded or failed command.
 Must be a valid LedgerString (as described in ``value.proto``).

 Required
      string command_id = 1;
      Returns:
      The bytes for commandId.

    • hasStatus

      boolean hasStatus()
       Identifies the exact type of the error.
 It uses the same format of conveying error details as it is used for the RPC responses of the APIs.

 Optional
      .google.rpc.Status status = 2;
      Returns:
      Whether the status field is set.

    • getStatus

      com.google.rpc.Status getStatus()
       Identifies the exact type of the error.
 It uses the same format of conveying error details as it is used for the RPC responses of the APIs.

 Optional
      .google.rpc.Status status = 2;
      Returns:
      The status.

    • getStatusOrBuilder

      com.google.rpc.StatusOrBuilder getStatusOrBuilder()
       Identifies the exact type of the error.
 It uses the same format of conveying error details as it is used for the RPC responses of the APIs.

 Optional
      .google.rpc.Status status = 2;

    • getUpdateId

      String getUpdateId()
       The update_id of the transaction or reassignment that resulted from the command with command_id.

 Only set for successfully executed commands.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string update_id = 3;
      Returns:
      The updateId.

    • getUpdateIdBytes

      com.google.protobuf.ByteString getUpdateIdBytes()
       The update_id of the transaction or reassignment that resulted from the command with command_id.

 Only set for successfully executed commands.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string update_id = 3;
      Returns:
      The bytes for updateId.

    • getUserId

      String getUserId()
       The user-id that was used for the submission, as described in ``commands.proto``.
 Must be a valid UserIdString (as described in ``value.proto``).

 Required
      string user_id = 4;
      Returns:
      The userId.

    • getUserIdBytes

      com.google.protobuf.ByteString getUserIdBytes()
       The user-id that was used for the submission, as described in ``commands.proto``.
 Must be a valid UserIdString (as described in ``value.proto``).

 Required
      string user_id = 4;
      Returns:
      The bytes for userId.

    • getActAsList

      List<String> getActAsList()
       The set of parties on whose behalf the commands were executed.
 Contains the ``act_as`` parties from ``commands.proto``
 filtered to the requesting parties in CompletionStreamRequest.
 The order of the parties need not be the same as in the submission.
 Each element must be a valid PartyIdString (as described in ``value.proto``).

 Required: must be non-empty
      repeated string act_as = 5;
      Returns:
      A list containing the actAs.

    • getActAsCount

      int getActAsCount()
       The set of parties on whose behalf the commands were executed.
 Contains the ``act_as`` parties from ``commands.proto``
 filtered to the requesting parties in CompletionStreamRequest.
 The order of the parties need not be the same as in the submission.
 Each element must be a valid PartyIdString (as described in ``value.proto``).

 Required: must be non-empty
      repeated string act_as = 5;
      Returns:
      The count of actAs.

    • getActAs

      String getActAs(int index)
       The set of parties on whose behalf the commands were executed.
 Contains the ``act_as`` parties from ``commands.proto``
 filtered to the requesting parties in CompletionStreamRequest.
 The order of the parties need not be the same as in the submission.
 Each element must be a valid PartyIdString (as described in ``value.proto``).

 Required: must be non-empty
      repeated string act_as = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The actAs at the given index.

    • getActAsBytes

      com.google.protobuf.ByteString getActAsBytes(int index)
       The set of parties on whose behalf the commands were executed.
 Contains the ``act_as`` parties from ``commands.proto``
 filtered to the requesting parties in CompletionStreamRequest.
 The order of the parties need not be the same as in the submission.
 Each element must be a valid PartyIdString (as described in ``value.proto``).

 Required: must be non-empty
      repeated string act_as = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the actAs at the given index.

    • getSubmissionId

      String getSubmissionId()
       The submission ID this completion refers to, as described in ``commands.proto``.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string submission_id = 6;
      Returns:
      The submissionId.

    • getSubmissionIdBytes

      com.google.protobuf.ByteString getSubmissionIdBytes()
       The submission ID this completion refers to, as described in ``commands.proto``.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string submission_id = 6;
      Returns:
      The bytes for submissionId.

    • hasDeduplicationOffset

      boolean hasDeduplicationOffset()
       Specifies the start of the deduplication period by a completion stream offset (exclusive).

 Must be a valid absolute offset (positive integer) or participant begin (zero).
      int64 deduplication_offset = 7;
      Returns:
      Whether the deduplicationOffset field is set.

    • getDeduplicationOffset

      long getDeduplicationOffset()
       Specifies the start of the deduplication period by a completion stream offset (exclusive).

 Must be a valid absolute offset (positive integer) or participant begin (zero).
      int64 deduplication_offset = 7;
      Returns:
      The deduplicationOffset.

    • hasDeduplicationDuration

      boolean hasDeduplicationDuration()
       Specifies the length of the deduplication period.
 It is measured in record time of completions.

 Must be non-negative.
      .google.protobuf.Duration deduplication_duration = 8;
      Returns:
      Whether the deduplicationDuration field is set.

    • getDeduplicationDuration

      com.google.protobuf.Duration getDeduplicationDuration()
       Specifies the length of the deduplication period.
 It is measured in record time of completions.

 Must be non-negative.
      .google.protobuf.Duration deduplication_duration = 8;
      Returns:
      The deduplicationDuration.

    • getDeduplicationDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDeduplicationDurationOrBuilder()
       Specifies the length of the deduplication period.
 It is measured in record time of completions.

 Must be non-negative.
      .google.protobuf.Duration deduplication_duration = 8;

    • hasTraceContext

      boolean hasTraceContext()
       The 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.

 Optional
      .com.daml.ledger.api.v2.TraceContext trace_context = 9;
      Returns:
      Whether the traceContext field is set.

    • getTraceContext

      TraceContextOuterClass.TraceContext getTraceContext()
       The 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.

 Optional
      .com.daml.ledger.api.v2.TraceContext trace_context = 9;
      Returns:
      The traceContext.

    • getTraceContextOrBuilder

      TraceContextOuterClass.TraceContextOrBuilder getTraceContextOrBuilder()
       The 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.

 Optional
      .com.daml.ledger.api.v2.TraceContext trace_context = 9;

    • getOffset

      long getOffset()
       May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.
 Must be a valid absolute offset (positive integer).

 Required
      int64 offset = 10;
      Returns:
      The offset.

    • hasSynchronizerTime

      boolean hasSynchronizerTime()
       The synchronizer along with its record time.
 The synchronizer id provided, in case of

 - successful/failed transactions: identifies the synchronizer of the transaction
 - for successful/failed unassign commands: identifies the source synchronizer
 - for successful/failed assign commands: identifies the target synchronizer

 Required
      .com.daml.ledger.api.v2.SynchronizerTime synchronizer_time = 11;
      Returns:
      Whether the synchronizerTime field is set.

    • getSynchronizerTime

      OffsetCheckpointOuterClass.SynchronizerTime getSynchronizerTime()
       The synchronizer along with its record time.
 The synchronizer id provided, in case of

 - successful/failed transactions: identifies the synchronizer of the transaction
 - for successful/failed unassign commands: identifies the source synchronizer
 - for successful/failed assign commands: identifies the target synchronizer

 Required
      .com.daml.ledger.api.v2.SynchronizerTime synchronizer_time = 11;
      Returns:
      The synchronizerTime.

    • getSynchronizerTimeOrBuilder

      OffsetCheckpointOuterClass.SynchronizerTimeOrBuilder getSynchronizerTimeOrBuilder()
       The synchronizer along with its record time.
 The synchronizer id provided, in case of

 - successful/failed transactions: identifies the synchronizer of the transaction
 - for successful/failed unassign commands: identifies the source synchronizer
 - for successful/failed assign commands: identifies the target synchronizer

 Required
      .com.daml.ledger.api.v2.SynchronizerTime synchronizer_time = 11;

    • getPaidTrafficCost

      long getPaidTrafficCost()
       The traffic cost paid by this participant node for the confirmation request
 for the submitted command.

 Commands whose execution is rejected before their corresponding
 confirmation request is ordered by the synchronizer will report a paid
 traffic cost of zero.
 If a confirmation request is ordered for a command, but the request fails
 (e.g., due to contention with a concurrent contract archival), the traffic
 cost is paid and reported on the failed completion for the request.

 If you want to correlate the traffic cost of a successful completion
 with the transaction that resulted from the command, you can use the
 ``offset`` field to retrieve the transaction using
 ``UpdateService.GetUpdateByOffset`` on the same participant node; or alternatively use the ``update_id``
 field to retrieve the transaction using ``UpdateService.GetUpdateById`` on any participant node
 that sees the transaction.

 Note: for completions processed before the participant started serving
 traffic cost on the Ledger API, this field will be set to zero.
 Additionally, the total cost incurred by the submitting node for the submission of the transaction may be greater
 than the reported cost, for example if retries were issued due to failed submissions to the synchronizer.
 The cost reported here is the one paid for ordering the confirmation request.

 Optional
      int64 paid_traffic_cost = 12;
      Returns:
      The paidTrafficCost.

    • getDeduplicationPeriodCase

      CompletionOuterClass.Completion.DeduplicationPeriodCase getDeduplicationPeriodCase()