Package com.daml.ledger.api.v1

Interface CommandCompletionServiceOuterClass.CompletionStreamRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getApplicationId()
      Only completions of commands submitted with the same application_id will be visible in the stream.
      com.google.protobuf.ByteString getApplicationIdBytes()
      Only completions of commands submitted with the same application_id will be visible in the stream.
      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.
      LedgerOffsetOuterClass.LedgerOffset getOffset()
      This field indicates the minimum offset for completions.
      LedgerOffsetOuterClass.LedgerOffsetOrBuilder getOffsetOrBuilder()
      This field indicates the minimum offset for completions.
      java.lang.String getParties​(int index)
      Non-empty list of parties whose data should be included.
      com.google.protobuf.ByteString getPartiesBytes​(int index)
      Non-empty list of parties whose data should be included.
      int getPartiesCount()
      Non-empty list of parties whose data should be included.
      java.util.List<java.lang.String> getPartiesList()
      Non-empty list of parties whose data should be included.
      boolean hasOffset()
      This field indicates the minimum offset for completions.

      • 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

      • 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``).
 Optional
        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``).
 Optional
        string ledger_id = 1 [json_name = "ledgerId"];
        Returns:
        The bytes for ledgerId.

      • getApplicationId

        java.lang.String getApplicationId()
         Only completions of commands submitted with the same application_id will be visible in the stream.
 Must be a valid ApplicationIdString (as described in ``value.proto``).
 Required unless authentication is used with a user token or a custom token specifying an application-id.
 In that case, the token's user-id, respectively application-id, will be used for the request's application_id.
        string application_id = 2 [json_name = "applicationId"];
        Returns:
        The applicationId.

      • getApplicationIdBytes

        com.google.protobuf.ByteString getApplicationIdBytes()
         Only completions of commands submitted with the same application_id will be visible in the stream.
 Must be a valid ApplicationIdString (as described in ``value.proto``).
 Required unless authentication is used with a user token or a custom token specifying an application-id.
 In that case, the token's user-id, respectively application-id, will be used for the request's application_id.
        string application_id = 2 [json_name = "applicationId"];
        Returns:
        The bytes for applicationId.

      • getPartiesList

        java.util.List<java.lang.String> getPartiesList()
         Non-empty list of parties whose data should be included.
 Only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties
 will be visible in the stream.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string parties = 3 [json_name = "parties"];
        Returns:
        A list containing the parties.

      • getPartiesCount

        int getPartiesCount()
         Non-empty list of parties whose data should be included.
 Only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties
 will be visible in the stream.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string parties = 3 [json_name = "parties"];
        Returns:
        The count of parties.

      • getParties

        java.lang.String getParties​(int index)
         Non-empty list of parties whose data should be included.
 Only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties
 will be visible in the stream.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string parties = 3 [json_name = "parties"];
        Parameters:
        index - The index of the element to return.
        Returns:
        The parties at the given index.

      • getPartiesBytes

        com.google.protobuf.ByteString getPartiesBytes​(int index)
         Non-empty list of parties whose data should be included.
 Only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties
 will be visible in the stream.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
        repeated string parties = 3 [json_name = "parties"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the parties at the given index.

      • hasOffset

        boolean hasOffset()
         This field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
 This offset is exclusive: the response will only contain commands whose offset is strictly greater than this.
 Optional, if not set the ledger uses the current ledger end offset instead.
        .com.daml.ledger.api.v1.LedgerOffset offset = 4 [json_name = "offset"];
        Returns:
        Whether the offset field is set.

      • getOffset

        LedgerOffsetOuterClass.LedgerOffset getOffset()
         This field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
 This offset is exclusive: the response will only contain commands whose offset is strictly greater than this.
 Optional, if not set the ledger uses the current ledger end offset instead.
        .com.daml.ledger.api.v1.LedgerOffset offset = 4 [json_name = "offset"];
        Returns:
        The offset.

      • getOffsetOrBuilder

        LedgerOffsetOuterClass.LedgerOffsetOrBuilder getOffsetOrBuilder()
         This field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
 This offset is exclusive: the response will only contain commands whose offset is strictly greater than this.
 Optional, if not set the ledger uses the current ledger end offset instead.
        .com.daml.ledger.api.v1.LedgerOffset offset = 4 [json_name = "offset"];