Package com.daml.ledger.api.v2

Interface CommandsOuterClass.CommandsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CommandsOuterClass.Commands, CommandsOuterClass.Commands.Builder
Enclosing class:
CommandsOuterClass
public static interface CommandsOuterClass.CommandsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getWorkflowId

      String getWorkflowId()
       Identifier of the on-ledger workflow that this command is a part of.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string workflow_id = 1 [json_name = "workflowId"];
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      com.google.protobuf.ByteString getWorkflowIdBytes()
       Identifier of the on-ledger workflow that this command is a part of.
 Must be a valid LedgerString (as described in ``value.proto``).
 Optional
      string workflow_id = 1 [json_name = "workflowId"];
      Returns:
      The bytes for workflowId.

    • getUserId

      String getUserId()
       Uniquely identifies the participant user that issued the command.
 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 = 2 [json_name = "userId"];
      Returns:
      The userId.

    • getUserIdBytes

      com.google.protobuf.ByteString getUserIdBytes()
       Uniquely identifies the participant user that issued the command.
 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 = 2 [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 = 3 [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 = 3 [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 = 4 [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 = 4 [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 = 4 [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 = 4 [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 = 4 [json_name = "commands"];

    • hasDeduplicationDuration

      boolean hasDeduplicationDuration()
       Specifies the length of the deduplication period.
 It is interpreted relative to the local clock at some point during the submission's processing.
 Must be non-negative. Must not exceed the maximum deduplication time.
      .google.protobuf.Duration deduplication_duration = 5 [json_name = "deduplicationDuration"];
      Returns:
      Whether the deduplicationDuration field is set.

    • getDeduplicationDuration

      com.google.protobuf.Duration getDeduplicationDuration()
       Specifies the length of the deduplication period.
 It is interpreted relative to the local clock at some point during the submission's processing.
 Must be non-negative. Must not exceed the maximum deduplication time.
      .google.protobuf.Duration deduplication_duration = 5 [json_name = "deduplicationDuration"];
      Returns:
      The deduplicationDuration.

    • getDeduplicationDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDeduplicationDurationOrBuilder()
       Specifies the length of the deduplication period.
 It is interpreted relative to the local clock at some point during the submission's processing.
 Must be non-negative. Must not exceed the maximum deduplication time.
      .google.protobuf.Duration deduplication_duration = 5 [json_name = "deduplicationDuration"];

    • hasDeduplicationOffset

      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 = 6 [json_name = "deduplicationOffset"];
      Returns:
      Whether the deduplicationOffset field is set.

    • getDeduplicationOffset

      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 = 6 [json_name = "deduplicationOffset"];
      Returns:
      The deduplicationOffset.

    • hasMinLedgerTimeAbs

      boolean hasMinLedgerTimeAbs()
       Lower bound for the ledger time assigned to the resulting transaction.
 Note: The ledger time of a transaction is assigned as part of command interpretation.
 Use this property if you expect that command interpretation will take a considerate amount of time, such that by
 the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.
 Must not be set at the same time as min_ledger_time_rel.
 Optional
      .google.protobuf.Timestamp min_ledger_time_abs = 7 [json_name = "minLedgerTimeAbs"];
      Returns:
      Whether the minLedgerTimeAbs field is set.

    • getMinLedgerTimeAbs

      com.google.protobuf.Timestamp getMinLedgerTimeAbs()
       Lower bound for the ledger time assigned to the resulting transaction.
 Note: The ledger time of a transaction is assigned as part of command interpretation.
 Use this property if you expect that command interpretation will take a considerate amount of time, such that by
 the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.
 Must not be set at the same time as min_ledger_time_rel.
 Optional
      .google.protobuf.Timestamp min_ledger_time_abs = 7 [json_name = "minLedgerTimeAbs"];
      Returns:
      The minLedgerTimeAbs.

    • getMinLedgerTimeAbsOrBuilder

      com.google.protobuf.TimestampOrBuilder getMinLedgerTimeAbsOrBuilder()
       Lower bound for the ledger time assigned to the resulting transaction.
 Note: The ledger time of a transaction is assigned as part of command interpretation.
 Use this property if you expect that command interpretation will take a considerate amount of time, such that by
 the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.
 Must not be set at the same time as min_ledger_time_rel.
 Optional
      .google.protobuf.Timestamp min_ledger_time_abs = 7 [json_name = "minLedgerTimeAbs"];

    • hasMinLedgerTimeRel

      boolean hasMinLedgerTimeRel()
       Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.
 Must not be set at the same time as min_ledger_time_abs.
 Optional
      .google.protobuf.Duration min_ledger_time_rel = 8 [json_name = "minLedgerTimeRel"];
      Returns:
      Whether the minLedgerTimeRel field is set.

    • getMinLedgerTimeRel

      com.google.protobuf.Duration getMinLedgerTimeRel()
       Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.
 Must not be set at the same time as min_ledger_time_abs.
 Optional
      .google.protobuf.Duration min_ledger_time_rel = 8 [json_name = "minLedgerTimeRel"];
      Returns:
      The minLedgerTimeRel.

    • getMinLedgerTimeRelOrBuilder

      com.google.protobuf.DurationOrBuilder getMinLedgerTimeRelOrBuilder()
       Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.
 Must not be set at the same time as min_ledger_time_abs.
 Optional
      .google.protobuf.Duration min_ledger_time_rel = 8 [json_name = "minLedgerTimeRel"];

    • getActAsList

      List<String> getActAsList()
       Set of parties on whose behalf the command should be executed.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to act on behalf of each of the given parties.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 9 [json_name = "actAs"];
      Returns:
      A list containing the actAs.

    • getActAsCount

      int getActAsCount()
       Set of parties on whose behalf the command should be executed.
 If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to act on behalf of each of the given parties.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 9 [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 ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to act on behalf of each of the given parties.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 9 [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 ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
 to act on behalf of each of the given parties.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Required, must be non-empty.
      repeated string act_as = 9 [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 participant node of a Daml network can host multiple parties. Each contract present on the participant
 node is only visible to a subset of these parties. 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 = 10 [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 participant node of a Daml network can host multiple parties. Each contract present on the participant
 node is only visible to a subset of these parties. 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 = 10 [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 participant node of a Daml network can host multiple parties. Each contract present on the participant
 node is only visible to a subset of these parties. 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 = 10 [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 participant node of a Daml network can host multiple parties. Each contract present on the participant
 node is only visible to a subset of these parties. 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 = 10 [json_name = "readAs"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the readAs at the given index.

    • getSubmissionId

      String getSubmissionId()
       A unique identifier to distinguish completions for different submissions with the same change ID.
 Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
 with the same change ID.
 Must be a valid LedgerString (as described in ``value.proto``).

 If omitted, the participant or the committer may set a value of their choice.
 Optional
      string submission_id = 11 [json_name = "submissionId"];
      Returns:
      The submissionId.

    • getSubmissionIdBytes

      com.google.protobuf.ByteString getSubmissionIdBytes()
       A unique identifier to distinguish completions for different submissions with the same change ID.
 Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
 with the same change ID.
 Must be a valid LedgerString (as described in ``value.proto``).

 If omitted, the participant or the committer may set a value of their choice.
 Optional
      string submission_id = 11 [json_name = "submissionId"];
      Returns:
      The bytes for submissionId.

    • getDisclosedContractsList

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

    • getSynchronizerId

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

    • getSynchronizerIdBytes

      com.google.protobuf.ByteString getSynchronizerIdBytes()
       Must be a valid synchronizer id
 Optional
      string synchronizer_id = 13 [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 = 14 [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 = 14 [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 = 14 [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 = 14 [json_name = "packageIdSelectionPreference"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the packageIdSelectionPreference at the given index.

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

    • getDeduplicationPeriodCase

      CommandsOuterClass.Commands.DeduplicationPeriodCase getDeduplicationPeriodCase()