Package com.daml.ledger.api.v1

Class CompletionOuterClass.Completion

  • All Implemented Interfaces:
    CompletionOuterClass.CompletionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.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.v1.Completion
    See Also:
    Serialized Form

    • Field Detail

      • COMMAND_ID_FIELD_NUMBER

        public static final int COMMAND_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSACTION_ID_FIELD_NUMBER

        public static final int TRANSACTION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • APPLICATION_ID_FIELD_NUMBER

        public static final int APPLICATION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUBMISSION_ID_FIELD_NUMBER

        public static final int SUBMISSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEDUPLICATION_OFFSET_FIELD_NUMBER

        public static final int DEDUPLICATION_OFFSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEDUPLICATION_DURATION_FIELD_NUMBER

        public static final int DEDUPLICATION_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRACE_CONTEXT_FIELD_NUMBER

        public static final int TRACE_CONTEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getCommandId

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

      • getTransactionId

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

      • getTransactionIdBytes

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

      • getApplicationId

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

      • getApplicationIdBytes

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

      • getActAsList

        public com.google.protobuf.ProtocolStringList 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"];
        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 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"];
        Specified by:
        getActAsCount in interface CompletionOuterClass.CompletionOrBuilder
        Returns:
        The count of actAs.

      • getActAs

        public 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"];
        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 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"];
        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 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"];
        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 LedgerString (as described in ``value.proto``).
        string deduplication_offset = 8 [json_name = "deduplicationOffset"];
        Specified by:
        hasDeduplicationOffset in interface CompletionOuterClass.CompletionOrBuilder
        Returns:
        Whether the deduplicationOffset field is set.

      • getDeduplicationOffset

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

      • getDeduplicationOffsetBytes

        public 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"];
        Specified by:
        getDeduplicationOffsetBytes in interface CompletionOuterClass.CompletionOrBuilder
        Returns:
        The bytes for 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 = 9 [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 = 9 [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 = 9 [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.v1.TraceContext trace_context = 10 [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.v1.TraceContext trace_context = 10 [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.v1.TraceContext trace_context = 10 [json_name = "traceContext"];
        Specified by:
        getTraceContextOrBuilder 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompletionOuterClass.Completion parseFrom​(java.nio.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​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static CompletionOuterClass.Completion parseFrom​(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.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

      • 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

      • 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