Package com.daml.ledger.api.v1

Interface CompletionOuterClass.CompletionOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.util.List<java.lang.String> getActAsList()
      The set of parties on whose behalf the commands were executed.
      java.lang.String getApplicationId()
      The application-id or user-id that was used for the submission, as described in ``commands.proto``.
      com.google.protobuf.ByteString getApplicationIdBytes()
      The application-id or user-id that was used for the submission, as described in ``commands.proto``.
      java.lang.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.
      java.lang.String getDeduplicationOffset()
      Specifies the start of the deduplication period by a completion stream offset (exclusive).
      com.google.protobuf.ByteString getDeduplicationOffsetBytes()
      Specifies the start of the deduplication period by a completion stream offset (exclusive).
      CompletionOuterClass.Completion.DeduplicationPeriodCase getDeduplicationPeriodCase()  
      com.google.rpc.Status getStatus()
      Identifies the exact type of the error.
      com.google.rpc.StatusOrBuilder getStatusOrBuilder()
      Identifies the exact type of the error.
      java.lang.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``.
      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.
      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.
      java.lang.String getTransactionId()
      The transaction_id of the transaction that resulted from the command with command_id.
      com.google.protobuf.ByteString getTransactionIdBytes()
      The transaction_id of the transaction that resulted from the command with command_id.
      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 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.

      • 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 Detail

      • getCommandId

        java.lang.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 [json_name = "commandId"];
        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 [json_name = "commandId"];
        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 [json_name = "status"];
        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 [json_name = "status"];
        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 [json_name = "status"];

      • getTransactionId

        java.lang.String getTransactionId()
         The transaction_id of the transaction 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 transaction_id = 3 [json_name = "transactionId"];
        Returns:
        The transactionId.

      • getTransactionIdBytes

        com.google.protobuf.ByteString getTransactionIdBytes()
         The transaction_id of the transaction 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 transaction_id = 3 [json_name = "transactionId"];
        Returns:
        The bytes for transactionId.

      • getApplicationId

        java.lang.String getApplicationId()
         The application-id or user-id that was used for the submission, as described in ``commands.proto``.
 Must be a valid ApplicationIdString (as described in ``value.proto``).
 Optional for historic completions where this data is not available.
        string application_id = 4 [json_name = "applicationId"];
        Returns:
        The applicationId.

      • getApplicationIdBytes

        com.google.protobuf.ByteString getApplicationIdBytes()
         The application-id or user-id that was used for the submission, as described in ``commands.proto``.
 Must be a valid ApplicationIdString (as described in ``value.proto``).
 Optional for historic completions where this data is not available.
        string application_id = 4 [json_name = "applicationId"];
        Returns:
        The bytes for applicationId.

      • getActAsList

        java.util.List<java.lang.String> getActAsList()
         The set of parties on whose behalf the commands were executed.
 Contains the union of ``party`` and ``act_as`` from ``commands.proto``.
 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``).
 Optional for historic completions where this data is not available.
        repeated string act_as = 5 [json_name = "actAs"];
        Returns:
        A list containing the actAs.

      • getActAsCount

        int getActAsCount()
         The set of parties on whose behalf the commands were executed.
 Contains the union of ``party`` and ``act_as`` from ``commands.proto``.
 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``).
 Optional for historic completions where this data is not available.
        repeated string act_as = 5 [json_name = "actAs"];
        Returns:
        The count of actAs.

      • getActAs

        java.lang.String getActAs​(int index)
         The set of parties on whose behalf the commands were executed.
 Contains the union of ``party`` and ``act_as`` from ``commands.proto``.
 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``).
 Optional for historic completions where this data is not available.
        repeated string act_as = 5 [json_name = "actAs"];
        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 union of ``party`` and ``act_as`` from ``commands.proto``.
 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``).
 Optional for historic completions where this data is not available.
        repeated string act_as = 5 [json_name = "actAs"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the actAs at the given index.

      • getSubmissionId

        java.lang.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 [json_name = "submissionId"];
        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 [json_name = "submissionId"];
        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 LedgerString (as described in ``value.proto``).
        string deduplication_offset = 8 [json_name = "deduplicationOffset"];
        Returns:
        Whether the deduplicationOffset field is set.

      • getDeduplicationOffset

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

 Must be a valid LedgerString (as described in ``value.proto``).
        string deduplication_offset = 8 [json_name = "deduplicationOffset"];
        Returns:
        The deduplicationOffset.

      • getDeduplicationOffsetBytes

        com.google.protobuf.ByteString getDeduplicationOffsetBytes()
         Specifies the start of the deduplication period by a completion stream offset (exclusive).

 Must be a valid LedgerString (as described in ``value.proto``).
        string deduplication_offset = 8 [json_name = "deduplicationOffset"];
        Returns:
        The bytes for 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 = 9 [json_name = "deduplicationDuration"];
        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 = 9 [json_name = "deduplicationDuration"];
        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 = 9 [json_name = "deduplicationDuration"];

      • 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 = 10 [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 = 10 [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 = 10 [json_name = "traceContext"];