com.daml.ledger.api.v1

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 Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationId() Uniquely identifies the application (or its part) that issued the command.
com.google.protobuf.ByteString	getApplicationIdBytes() Uniquely identifies the application (or its part) that issued the command.
java.lang.String	getCommandId() Uniquely identified the command.
com.google.protobuf.ByteString	getCommandIdBytes() Uniquely identified the command.
CommandsOuterClass.Command	getCommands(int index) Individual elements of this atomic command.
int	getCommandsCount() Individual elements of this atomic command.
java.util.List<CommandsOuterClass.Command>	getCommandsList() Individual elements of this atomic command.
CommandsOuterClass.CommandOrBuilder	getCommandsOrBuilder(int index) Individual elements of this atomic command.
java.util.List<? extends CommandsOuterClass.CommandOrBuilder>	getCommandsOrBuilderList() Individual elements of this atomic command.
com.google.protobuf.Duration	getDeduplicationTime() The length of the time window during which all commands with the same party and command ID will be deduplicated.
com.google.protobuf.DurationOrBuilder	getDeduplicationTimeOrBuilder() The length of the time window during which all commands with the same party and command ID will be deduplicated.
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.
com.google.protobuf.Timestamp	getMinLedgerTimeAbs() Lower bound for the ledger time assigned to the resulting transaction.
com.google.protobuf.TimestampOrBuilder	getMinLedgerTimeAbsOrBuilder() Lower bound for the ledger time assigned to the resulting transaction.
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.
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.
java.lang.String	getParty() Party on whose behalf the command should be executed.
com.google.protobuf.ByteString	getPartyBytes() Party on whose behalf the command should be executed.
java.lang.String	getWorkflowId() Identifier of the on-ledger workflow that this command is a part of.
com.google.protobuf.ByteString	getWorkflowIdBytes() Identifier of the on-ledger workflow that this command is a part of.
boolean	hasDeduplicationTime() The length of the time window during which all commands with the same party and command ID will be deduplicated.
boolean	hasMinLedgerTimeAbs() Lower bound for the ledger time assigned to the resulting transaction.
boolean	hasMinLedgerTimeRel() Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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``).
 Required
 

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``).
 Required
 

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 its part) that issued the command. This is used in tracing
 across different components and to let applications subscribe to their own submissions only.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
 

string application_id = 3[json_name = "applicationId"];

Returns:

The applicationId.

getApplicationIdBytes

com.google.protobuf.ByteString getApplicationIdBytes()

 Uniquely identifies the application (or its part) that issued the command. This is used in tracing
 across different components and to let applications subscribe to their own submissions only.
 Must be a valid LedgerString (as described in ``value.proto``).
 Required
 

string application_id = 3[json_name = "applicationId"];

Returns:

The bytes for applicationId.

getCommandId

java.lang.String getCommandId()

 Uniquely identified the command. This identifier should be unique for each new command within an
 application domain, i.e., the triple (application_id, party, command_id) must be unique.
 It can be used for matching the requests with their respective 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 identified the command. This identifier should be unique for each new command within an
 application domain, i.e., the triple (application_id, party, command_id) must be unique.
 It can be used for matching the requests with their respective 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. It is up to the server to verify that the
 authorisation can be granted and that the connection has been authenticated for that party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
 

string party = 5[json_name = "party"];

Returns:

The party.

getPartyBytes

com.google.protobuf.ByteString getPartyBytes()

 Party on whose behalf the command should be executed. It is up to the server to verify that the
 authorisation can be granted and that the connection has been authenticated for that party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
 

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

boolean hasDeduplicationTime()

 The length of the time window during which all commands with the same party and command ID will be deduplicated.
 Duplicate commands submitted before the end of this window return an ALREADY_EXISTS error.
 Optional
 

.google.protobuf.Duration deduplication_time = 9[json_name = "deduplicationTime"];

Returns:

Whether the deduplicationTime field is set.

getDeduplicationTime

com.google.protobuf.Duration getDeduplicationTime()

 The length of the time window during which all commands with the same party and command ID will be deduplicated.
 Duplicate commands submitted before the end of this window return an ALREADY_EXISTS error.
 Optional
 

.google.protobuf.Duration deduplication_time = 9[json_name = "deduplicationTime"];

Returns:

The deduplicationTime.

getDeduplicationTimeOrBuilder

com.google.protobuf.DurationOrBuilder getDeduplicationTimeOrBuilder()

 The length of the time window during which all commands with the same party and command ID will be deduplicated.
 Duplicate commands submitted before the end of this window return an ALREADY_EXISTS error.
 Optional
 

.google.protobuf.Duration deduplication_time = 9[json_name = "deduplicationTime"];

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