Package com.daml.ledger.api.v1

Interface CommandsOuterClass.CommandsOrBuilder

    • 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.

      • getWorkflowId

        java.lang.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 = 2 [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 = 2 [json_name = "workflowId"];
        Returns:
        The bytes for workflowId.

      • getApplicationId

        java.lang.String getApplicationId()
         Uniquely identifies the application or participant user that issued the command.
 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 = 3 [json_name = "applicationId"];
        Returns:
        The applicationId.

      • getApplicationIdBytes

        com.google.protobuf.ByteString getApplicationIdBytes()
         Uniquely identifies the application or participant user that issued the command.
 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 = 3 [json_name = "applicationId"];
        Returns:
        The bytes for applicationId.

      • getCommandId

        java.lang.String getCommandId()
         Uniquely identifies the command.
 The triple (application_id, party + act_as, command_id) constitutes the change ID for the intended ledger change,
 where party + 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 = 4 [json_name = "commandId"];
        Returns:
        The commandId.

      • getCommandIdBytes

        com.google.protobuf.ByteString getCommandIdBytes()
         Uniquely identifies the command.
 The triple (application_id, party + act_as, command_id) constitutes the change ID for the intended ledger change,
 where party + 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 = 4 [json_name = "commandId"];
        Returns:
        The bytes for commandId.

      • getParty

        java.lang.String getParty()
         Party 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 the given party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Deprecated in favor of the ``act_as`` field. If both are set, then the effective list of parties on whose
 behalf the command should be executed is the union of all parties listed in ``party`` and ``act_as``.
 Optional
        string party = 5 [json_name = "party"];
        Returns:
        The party.

      • getPartyBytes

        com.google.protobuf.ByteString getPartyBytes()
         Party 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 the given party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Deprecated in favor of the ``act_as`` field. If both are set, then the effective list of parties on whose
 behalf the command should be executed is the union of all parties listed in ``party`` and ``act_as``.
 Optional
        string party = 5 [json_name = "party"];
        Returns:
        The bytes for party.

      • getCommandsList

        java.util.List<CommandsOuterClass.Command> getCommandsList()
         Individual elements of this atomic command. Must be non-empty.
 Required
        repeated .com.daml.ledger.api.v1.Command commands = 8 [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.v1.Command commands = 8 [json_name = "commands"];

      • getCommandsCount

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

      • getCommandsOrBuilderList

        java.util.List<? extends CommandsOuterClass.CommandOrBuilder> getCommandsOrBuilderList()
         Individual elements of this atomic command. Must be non-empty.
 Required
        repeated .com.daml.ledger.api.v1.Command commands = 8 [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.v1.Command commands = 8 [json_name = "commands"];

      • hasDeduplicationTime

        @Deprecated
boolean hasDeduplicationTime()
        Deprecated.
        com.daml.ledger.api.v1.Commands.deduplication_time is deprecated. See com/daml/ledger/api/v1/commands.proto;l=67
         Specifies the length of the deduplication period.
 Same semantics apply as for `deduplication_duration`.
 Must be non-negative. Must not exceed the maximum deduplication time (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_time = 9 [json_name = "deduplicationTime", deprecated = true];
        Returns:
        Whether the deduplicationTime field is set.

      • getDeduplicationTime

        @Deprecated
com.google.protobuf.Duration getDeduplicationTime()
        Deprecated.
        com.daml.ledger.api.v1.Commands.deduplication_time is deprecated. See com/daml/ledger/api/v1/commands.proto;l=67
         Specifies the length of the deduplication period.
 Same semantics apply as for `deduplication_duration`.
 Must be non-negative. Must not exceed the maximum deduplication time (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_time = 9 [json_name = "deduplicationTime", deprecated = true];
        Returns:
        The deduplicationTime.

      • getDeduplicationTimeOrBuilder

        @Deprecated
com.google.protobuf.DurationOrBuilder getDeduplicationTimeOrBuilder()
        Deprecated.
         Specifies the length of the deduplication period.
 Same semantics apply as for `deduplication_duration`.
 Must be non-negative. Must not exceed the maximum deduplication time (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_time = 9 [json_name = "deduplicationTime", deprecated = true];

      • 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 (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_duration = 15 [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 (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_duration = 15 [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 (see
 ``ledger_configuration_service.proto``).
        .google.protobuf.Duration deduplication_duration = 15 [json_name = "deduplicationDuration"];

      • hasDeduplicationOffset

        boolean hasDeduplicationOffset()
         Specifies the start of the deduplication period by a completion stream offset (exclusive).
 Must be a valid LedgerString (as described in ``ledger_offset.proto``).
        string deduplication_offset = 16 [json_name = "deduplicationOffset"];
        Returns:
        Whether the deduplicationOffset field is set.

      • getDeduplicationOffset

        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 ``ledger_offset.proto``).
        string deduplication_offset = 16 [json_name = "deduplicationOffset"];
        Returns:
        The deduplicationOffset.

      • getDeduplicationOffsetBytes

        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 ``ledger_offset.proto``).
        string deduplication_offset = 16 [json_name = "deduplicationOffset"];
        Returns:
        The bytes for 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 = 10 [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 = 10 [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 = 10 [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 = 11 [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 = 11 [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 = 11 [json_name = "minLedgerTimeRel"];

      • getActAsList

        java.util.List<java.lang.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.
 This field supersedes the ``party`` field. The effective set of parties on whose behalf the command
 should be executed is the union of all parties listed in ``party`` and ``act_as``, which must be non-empty.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Optional
        repeated string act_as = 12 [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.
 This field supersedes the ``party`` field. The effective set of parties on whose behalf the command
 should be executed is the union of all parties listed in ``party`` and ``act_as``, which must be non-empty.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Optional
        repeated string act_as = 12 [json_name = "actAs"];
        Returns:
        The count of actAs.

      • getActAs

        java.lang.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.
 This field supersedes the ``party`` field. The effective set of parties on whose behalf the command
 should be executed is the union of all parties listed in ``party`` and ``act_as``, which must be non-empty.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Optional
        repeated string act_as = 12 [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.
 This field supersedes the ``party`` field. The effective set of parties on whose behalf the command
 should be executed is the union of all parties listed in ``party`` and ``act_as``, which must be non-empty.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Optional
        repeated string act_as = 12 [json_name = "actAs"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the actAs at the given index.

      • getReadAsList

        java.util.List<java.lang.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 = 13 [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 = 13 [json_name = "readAs"];
        Returns:
        The count of readAs.

      • getReadAs

        java.lang.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 = 13 [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 = 13 [json_name = "readAs"];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the readAs at the given index.

      • getSubmissionId

        java.lang.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 = 14 [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 = 14 [json_name = "submissionId"];
        Returns:
        The bytes for submissionId.

      • getDisclosedContractsList

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

      • getDisclosedContracts

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

      • getDisclosedContractsCount

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

      • getDisclosedContractsOrBuilderList

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

      • getDisclosedContractsOrBuilder

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