Package com.daml.ledger.api.v2

Class CompletionOuterClass.Completion

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.CompletionOuterClass.Completion
All Implemented Interfaces:
CompletionOuterClass.CompletionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
CompletionOuterClass
public static final class CompletionOuterClass.Completion extends com.google.protobuf.GeneratedMessageV3 implements CompletionOuterClass.CompletionOrBuilder
 A completion represents the status of a submitted command on the ledger: it can be successful or failed.
Protobuf type com.daml.ledger.api.v2.Completion
See Also:

  • Field Details

    • COMMAND_ID_FIELD_NUMBER

      public static final int COMMAND_ID_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • UPDATE_ID_FIELD_NUMBER

      public static final int UPDATE_ID_FIELD_NUMBER
      See Also:

    • USER_ID_FIELD_NUMBER

      public static final int USER_ID_FIELD_NUMBER
      See Also:

    • ACT_AS_FIELD_NUMBER

      public static final int ACT_AS_FIELD_NUMBER
      See Also:

    • SUBMISSION_ID_FIELD_NUMBER

      public static final int SUBMISSION_ID_FIELD_NUMBER
      See Also:

    • DEDUPLICATION_OFFSET_FIELD_NUMBER

      public static final int DEDUPLICATION_OFFSET_FIELD_NUMBER
      See Also:

    • DEDUPLICATION_DURATION_FIELD_NUMBER

      public static final int DEDUPLICATION_DURATION_FIELD_NUMBER
      See Also:

    • TRACE_CONTEXT_FIELD_NUMBER

      public static final int TRACE_CONTEXT_FIELD_NUMBER
      See Also:

    • OFFSET_FIELD_NUMBER

      public static final int OFFSET_FIELD_NUMBER
      See Also:

    • SYNCHRONIZER_TIME_FIELD_NUMBER

      public static final int SYNCHRONIZER_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDeduplicationPeriodCase

      public CompletionOuterClass.Completion.DeduplicationPeriodCase getDeduplicationPeriodCase()
      Specified by:
      getDeduplicationPeriodCase in interface CompletionOuterClass.CompletionOrBuilder

    • getCommandId

      public 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"];
      Specified by:
      getCommandId in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The commandId.

    • getCommandIdBytes

      public 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"];
      Specified by:
      getCommandIdBytes in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The bytes for commandId.

    • hasStatus

      public 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"];
      Specified by:
      hasStatus in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public 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"];
      Specified by:
      getStatus in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public 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"];
      Specified by:
      getStatusOrBuilder in interface CompletionOuterClass.CompletionOrBuilder

    • getUpdateId

      public 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``).
      string update_id = 3 [json_name = "updateId"];
      Specified by:
      getUpdateId in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The updateId.

    • getUpdateIdBytes

      public 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``).
      string update_id = 3 [json_name = "updateId"];
      Specified by:
      getUpdateIdBytes in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The bytes for updateId.

    • getUserId

      public 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``).
 Optional for historic completions where this data is not available.
      string user_id = 4 [json_name = "userId"];
      Specified by:
      getUserId in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The userId.

    • getUserIdBytes

      public 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``).
 Optional for historic completions where this data is not available.
      string user_id = 4 [json_name = "userId"];
      Specified by:
      getUserIdBytes in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The bytes for userId.

    • getActAsList

      public com.google.protobuf.ProtocolStringList 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``).
 Optional for historic completions where this data is not available.
      repeated string act_as = 5 [json_name = "actAs"];
      Specified by:
      getActAsList in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      A list containing the actAs.

    • getActAsCount

      public 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``).
 Optional for historic completions where this data is not available.
      repeated string act_as = 5 [json_name = "actAs"];
      Specified by:
      getActAsCount in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The count of actAs.

    • getActAs

      public 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``).
 Optional for historic completions where this data is not available.
      repeated string act_as = 5 [json_name = "actAs"];
      Specified by:
      getActAs in interface CompletionOuterClass.CompletionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The actAs at the given index.

    • getActAsBytes

      public 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``).
 Optional for historic completions where this data is not available.
      repeated string act_as = 5 [json_name = "actAs"];
      Specified by:
      getActAsBytes in interface CompletionOuterClass.CompletionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the actAs at the given index.

    • getSubmissionId

      public 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"];
      Specified by:
      getSubmissionId in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The submissionId.

    • getSubmissionIdBytes

      public 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"];
      Specified by:
      getSubmissionIdBytes in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The bytes for submissionId.

    • hasDeduplicationOffset

      public 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 [json_name = "deduplicationOffset"];
      Specified by:
      hasDeduplicationOffset in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      Whether the deduplicationOffset field is set.

    • getDeduplicationOffset

      public 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 [json_name = "deduplicationOffset"];
      Specified by:
      getDeduplicationOffset in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The deduplicationOffset.

    • hasDeduplicationDuration

      public 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 [json_name = "deduplicationDuration"];
      Specified by:
      hasDeduplicationDuration in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      Whether the deduplicationDuration field is set.

    • getDeduplicationDuration

      public 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 [json_name = "deduplicationDuration"];
      Specified by:
      getDeduplicationDuration in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The deduplicationDuration.

    • getDeduplicationDurationOrBuilder

      public 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 [json_name = "deduplicationDuration"];
      Specified by:
      getDeduplicationDurationOrBuilder in interface CompletionOuterClass.CompletionOrBuilder

    • hasTraceContext

      public 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.v2.TraceContext trace_context = 9 [json_name = "traceContext"];
      Specified by:
      hasTraceContext in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      Whether the traceContext field is set.

    • getTraceContext

      public 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.v2.TraceContext trace_context = 9 [json_name = "traceContext"];
      Specified by:
      getTraceContext in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The traceContext.

    • getTraceContextOrBuilder

      public 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.v2.TraceContext trace_context = 9 [json_name = "traceContext"];
      Specified by:
      getTraceContextOrBuilder in interface CompletionOuterClass.CompletionOrBuilder

    • getOffset

      public long getOffset()
       May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.
 Required, must be a valid absolute offset (positive integer).
      int64 offset = 10 [json_name = "offset"];
      Specified by:
      getOffset in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The offset.

    • hasSynchronizerTime

      public 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 [json_name = "synchronizerTime"];
      Specified by:
      hasSynchronizerTime in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      Whether the synchronizerTime field is set.

    • getSynchronizerTime

      public 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 [json_name = "synchronizerTime"];
      Specified by:
      getSynchronizerTime in interface CompletionOuterClass.CompletionOrBuilder
      Returns:
      The synchronizerTime.

    • getSynchronizerTimeOrBuilder

      public 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 [json_name = "synchronizerTime"];
      Specified by:
      getSynchronizerTimeOrBuilder in interface CompletionOuterClass.CompletionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CompletionOuterClass.Completion parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CompletionOuterClass.Completion parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CompletionOuterClass.Completion parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CompletionOuterClass.Completion.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CompletionOuterClass.Completion.Builder newBuilder()

    • newBuilder

      public static CompletionOuterClass.Completion.Builder newBuilder(CompletionOuterClass.Completion prototype)

    • toBuilder

      public CompletionOuterClass.Completion.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CompletionOuterClass.Completion.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CompletionOuterClass.Completion getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CompletionOuterClass.Completion> parser()

    • getParserForType

      public com.google.protobuf.Parser<CompletionOuterClass.Completion> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CompletionOuterClass.Completion getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder