Package com.daml.ledger.api.v2

Interface CommandCompletionServiceOuterClass.CompletionStreamRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CommandCompletionServiceOuterClass.CompletionStreamRequest, CommandCompletionServiceOuterClass.CompletionStreamRequest.Builder
Enclosing class:
CommandCompletionServiceOuterClass
public static interface CommandCompletionServiceOuterClass.CompletionStreamRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBeginExclusive()
    This optional field indicates the minimum offset for completions.
    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.
    List<String>
    getPartiesList()
    Non-empty list of parties whose data should be included.
    String
    getUserId()
    Only completions of commands submitted with the same user_id will be visible in the stream.
    com.google.protobuf.ByteString
    getUserIdBytes()
    Only completions of commands submitted with the same user_id will be visible in the stream.

    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

    • getUserId

      String getUserId()
       Only completions of commands submitted with the same user_id will be visible in the stream.
 Must be a valid UserIdString (as described in ``value.proto``).
 Required unless authentication is used with a user token.
 In that case, the token's user-id will be used for the request's user_id.
      string user_id = 1 [json_name = "userId"];
      Returns:
      The userId.

    • getUserIdBytes

      com.google.protobuf.ByteString getUserIdBytes()
       Only completions of commands submitted with the same user_id will be visible in the stream.
 Must be a valid UserIdString (as described in ``value.proto``).
 Required unless authentication is used with a user token.
 In that case, the token's user-id will be used for the request's user_id.
      string user_id = 1 [json_name = "userId"];
      Returns:
      The bytes for userId.

    • getPartiesList

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

    • getPartiesCount

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

    • getParties

      String getParties(int index)
       Non-empty list of parties whose data should be included.
 The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string parties = 2 [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.
 The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
      repeated string parties = 2 [json_name = "parties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the parties at the given index.

    • getBeginExclusive

      long getBeginExclusive()
       This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.
 If not set the ledger uses the ledger begin offset instead.
 If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset).
 If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.
      int64 begin_exclusive = 3 [json_name = "beginExclusive"];
      Returns:
      The beginExclusive.