Package com.daml.ledger.api.v2.interactive

Interface InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest, InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest.Builder
Enclosing class:
InteractiveSubmissionServiceOuterClass
public static interface InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getUserId

      String getUserId()
       Uniquely identifies the participant user that prepares the transaction.
 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()
       Uniquely identifies the participant user that prepares the transaction.
 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.

    • getCommandId

      String getCommandId()
       Uniquely identifies the command.
 The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
 where act_as is interpreted as a set of party names.
 The change ID can be used for matching the intended ledger changes with all their completions.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string command_id = 2 [json_name = "commandId"];
      Returns:
      The commandId.

    • getCommandIdBytes

      com.google.protobuf.ByteString getCommandIdBytes()
       Uniquely identifies the command.
 The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
 where act_as is interpreted as a set of party names.
 The change ID can be used for matching the intended ledger changes with all their completions.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
      string command_id = 2 [json_name = "commandId"];
      Returns:
      The bytes for commandId.

    • getCommandsList

      List<CommandsOuterClass.Command> getCommandsList()
       Individual elements of this atomic command. Must be non-empty.
 Required
      repeated .com.daml.ledger.api.v2.Command commands = 3 [json_name = "commands"];

    • getCommands

      CommandsOuterClass.Command getCommands(int index)
       Individual elements of this atomic command. Must be non-empty.
 Required
      repeated .com.daml.ledger.api.v2.Command commands = 3 [json_name = "commands"];

    • getCommandsCount

      int getCommandsCount()
       Individual elements of this atomic command. Must be non-empty.
 Required
      repeated .com.daml.ledger.api.v2.Command commands = 3 [json_name = "commands"];

    • getCommandsOrBuilderList

      List<? extends CommandsOuterClass.CommandOrBuilder> getCommandsOrBuilderList()
       Individual elements of this atomic command. Must be non-empty.
 Required
      repeated .com.daml.ledger.api.v2.Command commands = 3 [json_name = "commands"];

    • getCommandsOrBuilder

      CommandsOuterClass.CommandOrBuilder getCommandsOrBuilder(int index)
       Individual elements of this atomic command. Must be non-empty.
 Required
      repeated .com.daml.ledger.api.v2.Command commands = 3 [json_name = "commands"];

    • hasMinLedgerTime

      boolean hasMinLedgerTime()
       Optional
      .com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4 [json_name = "minLedgerTime"];
      Returns:
      Whether the minLedgerTime field is set.

    • getMinLedgerTime

      InteractiveSubmissionServiceOuterClass.MinLedgerTime getMinLedgerTime()
       Optional
      .com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4 [json_name = "minLedgerTime"];
      Returns:
      The minLedgerTime.

    • getMinLedgerTimeOrBuilder

      InteractiveSubmissionServiceOuterClass.MinLedgerTimeOrBuilder getMinLedgerTimeOrBuilder()
       Optional
      .com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4 [json_name = "minLedgerTime"];

    • getActAsList

      List<String> getActAsList()
       Set of parties on whose behalf the command should be executed, if submitted.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
 and does not execute it. Therefore read authorization is sufficient even for actAs parties.
 Note: This may change, and more specific authorization scope may be introduced in the future.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 5 [json_name = "actAs"];
      Returns:
      A list containing the actAs.

    • getActAsCount

      int getActAsCount()
       Set of parties on whose behalf the command should be executed, if submitted.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
 and does not execute it. Therefore read authorization is sufficient even for actAs parties.
 Note: This may change, and more specific authorization scope may be introduced in the future.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 5 [json_name = "actAs"];
      Returns:
      The count of actAs.

    • getActAs

      String getActAs(int index)
       Set of parties on whose behalf the command should be executed, if submitted.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
 and does not execute it. Therefore read authorization is sufficient even for actAs parties.
 Note: This may change, and more specific authorization scope may be introduced in the future.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      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)
       Set of parties on whose behalf the command should be executed, if submitted.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
 and does not execute it. Therefore read authorization is sufficient even for actAs parties.
 Note: This may change, and more specific authorization scope may be introduced in the future.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      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.

    • getReadAsList

      List<String> getReadAsList()
       Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
 This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
 Note: A command can only use contracts that are visible to at least
 one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
 rules for fetch operations.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to read contract data on behalf of each of the given parties.
 Optional
      repeated string read_as = 6 [json_name = "readAs"];
      Returns:
      A list containing the readAs.

    • getReadAsCount

      int getReadAsCount()
       Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
 This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
 Note: A command can only use contracts that are visible to at least
 one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
 rules for fetch operations.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to read contract data on behalf of each of the given parties.
 Optional
      repeated string read_as = 6 [json_name = "readAs"];
      Returns:
      The count of readAs.

    • getReadAs

      String getReadAs(int index)
       Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
 This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
 Note: A command can only use contracts that are visible to at least
 one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
 rules for fetch operations.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to read contract data on behalf of each of the given parties.
 Optional
      repeated string read_as = 6 [json_name = "readAs"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The readAs at the given index.

    • getReadAsBytes

      com.google.protobuf.ByteString getReadAsBytes(int index)
       Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
 This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
 Note: A command can only use contracts that are visible to at least
 one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
 rules for fetch operations.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to read contract data on behalf of each of the given parties.
 Optional
      repeated string read_as = 6 [json_name = "readAs"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the readAs at the given index.

    • getDisclosedContractsList

      List<CommandsOuterClass.DisclosedContract> getDisclosedContractsList()
       Additional contracts used to resolve contract & contract key lookups.
 Optional
      repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7 [json_name = "disclosedContracts"];

    • getDisclosedContracts

      CommandsOuterClass.DisclosedContract getDisclosedContracts(int index)
       Additional contracts used to resolve contract & contract key lookups.
 Optional
      repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7 [json_name = "disclosedContracts"];

    • getDisclosedContractsCount

      int getDisclosedContractsCount()
       Additional contracts used to resolve contract & contract key lookups.
 Optional
      repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7 [json_name = "disclosedContracts"];

    • getDisclosedContractsOrBuilderList

      List<? extends CommandsOuterClass.DisclosedContractOrBuilder> getDisclosedContractsOrBuilderList()
       Additional contracts used to resolve contract & contract key lookups.
 Optional
      repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7 [json_name = "disclosedContracts"];

    • getDisclosedContractsOrBuilder

      CommandsOuterClass.DisclosedContractOrBuilder getDisclosedContractsOrBuilder(int index)
       Additional contracts used to resolve contract & contract key lookups.
 Optional
      repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7 [json_name = "disclosedContracts"];

    • getSynchronizerId

      String getSynchronizerId()
       Must be a valid synchronizer id
 Required
      string synchronizer_id = 8 [json_name = "synchronizerId"];
      Returns:
      The synchronizerId.

    • getSynchronizerIdBytes

      com.google.protobuf.ByteString getSynchronizerIdBytes()
       Must be a valid synchronizer id
 Required
      string synchronizer_id = 8 [json_name = "synchronizerId"];
      Returns:
      The bytes for synchronizerId.

    • getPackageIdSelectionPreferenceList

      List<String> getPackageIdSelectionPreferenceList()
       The package-id selection preference of the client for resolving
 package names and interface instances in command submission and interpretation
      repeated string package_id_selection_preference = 9 [json_name = "packageIdSelectionPreference"];
      Returns:
      A list containing the packageIdSelectionPreference.

    • getPackageIdSelectionPreferenceCount

      int getPackageIdSelectionPreferenceCount()
       The package-id selection preference of the client for resolving
 package names and interface instances in command submission and interpretation
      repeated string package_id_selection_preference = 9 [json_name = "packageIdSelectionPreference"];
      Returns:
      The count of packageIdSelectionPreference.

    • getPackageIdSelectionPreference

      String getPackageIdSelectionPreference(int index)
       The package-id selection preference of the client for resolving
 package names and interface instances in command submission and interpretation
      repeated string package_id_selection_preference = 9 [json_name = "packageIdSelectionPreference"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The packageIdSelectionPreference at the given index.

    • getPackageIdSelectionPreferenceBytes

      com.google.protobuf.ByteString getPackageIdSelectionPreferenceBytes(int index)
       The package-id selection preference of the client for resolving
 package names and interface instances in command submission and interpretation
      repeated string package_id_selection_preference = 9 [json_name = "packageIdSelectionPreference"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the packageIdSelectionPreference at the given index.

    • getVerboseHashing

      boolean getVerboseHashing()
       When true, the response will contain additional details on how the transaction was encoded and hashed
 This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
      bool verbose_hashing = 10 [json_name = "verboseHashing"];
      Returns:
      The verboseHashing.

    • getPrefetchContractKeysList

      List<CommandsOuterClass.PrefetchContractKey> getPrefetchContractKeysList()
       Fetches the contract keys into the caches to speed up the command processing.
 Should only contain contract keys that are expected to be resolved during interpretation of the commands.
 Keys of disclosed contracts do not need prefetching.

 Optional
      repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15 [json_name = "prefetchContractKeys"];

    • getPrefetchContractKeys

      CommandsOuterClass.PrefetchContractKey getPrefetchContractKeys(int index)
       Fetches the contract keys into the caches to speed up the command processing.
 Should only contain contract keys that are expected to be resolved during interpretation of the commands.
 Keys of disclosed contracts do not need prefetching.

 Optional
      repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15 [json_name = "prefetchContractKeys"];

    • getPrefetchContractKeysCount

      int getPrefetchContractKeysCount()
       Fetches the contract keys into the caches to speed up the command processing.
 Should only contain contract keys that are expected to be resolved during interpretation of the commands.
 Keys of disclosed contracts do not need prefetching.

 Optional
      repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15 [json_name = "prefetchContractKeys"];

    • getPrefetchContractKeysOrBuilderList

      List<? extends CommandsOuterClass.PrefetchContractKeyOrBuilder> getPrefetchContractKeysOrBuilderList()
       Fetches the contract keys into the caches to speed up the command processing.
 Should only contain contract keys that are expected to be resolved during interpretation of the commands.
 Keys of disclosed contracts do not need prefetching.

 Optional
      repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15 [json_name = "prefetchContractKeys"];

    • getPrefetchContractKeysOrBuilder

      CommandsOuterClass.PrefetchContractKeyOrBuilder getPrefetchContractKeysOrBuilder(int index)
       Fetches the contract keys into the caches to speed up the command processing.
 Should only contain contract keys that are expected to be resolved during interpretation of the commands.
 Keys of disclosed contracts do not need prefetching.

 Optional
      repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15 [json_name = "prefetchContractKeys"];