Class InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.interactive.InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest
- All Implemented Interfaces:
InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
- Enclosing class:
InteractiveSubmissionServiceOuterClass
public static final class InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest
extends com.google.protobuf.GeneratedMessageV3
implements InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
Protobuf type
com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typecom.daml.ledger.api.v2.interactive.PrepareSubmissionRequestNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetActAs(int index) Set of parties on whose behalf the command should be executed, if submitted.com.google.protobuf.ByteStringgetActAsBytes(int index) Set of parties on whose behalf the command should be executed, if submitted.intSet of parties on whose behalf the command should be executed, if submitted.com.google.protobuf.ProtocolStringListSet of parties on whose behalf the command should be executed, if submitted.Uniquely identifies the command.com.google.protobuf.ByteStringUniquely identifies the command.getCommands(int index) Individual elements of this atomic command.intIndividual elements of this atomic command.Individual elements of this atomic command.getCommandsOrBuilder(int index) Individual elements of this atomic command.List<? extends CommandsOuterClass.CommandOrBuilder> Individual elements of this atomic command.static final com.google.protobuf.Descriptors.DescriptorgetDisclosedContracts(int index) Additional contracts used to resolve contract & contract key lookups.intAdditional contracts used to resolve contract & contract key lookups.Additional contracts used to resolve contract & contract key lookups.getDisclosedContractsOrBuilder(int index) Additional contracts used to resolve contract & contract key lookups.Additional contracts used to resolve contract & contract key lookups.Hints to improve the accuracy of traffic cost estimation.Hints to improve the accuracy of traffic cost estimation.The hashing scheme version to be used when building the hash.intThe hashing scheme version to be used when building the hash.com.google.protobuf.TimestampMaximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.com.google.protobuf.TimestampOrBuilderMaximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.OptionalOptionalgetPackageIdSelectionPreference(int index) The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be emptycom.google.protobuf.ByteStringgetPackageIdSelectionPreferenceBytes(int index) The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be emptyintThe package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be emptycom.google.protobuf.ProtocolStringListThe package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be emptycom.google.protobuf.Parser<InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest> getPrefetchContractKeys(int index) Fetches the contract keys into the caches to speed up the command processing.intFetches the contract keys into the caches to speed up the command processing.Fetches the contract keys into the caches to speed up the command processing.getPrefetchContractKeysOrBuilder(int index) Fetches the contract keys into the caches to speed up the command processing.Fetches the contract keys into the caches to speed up the command processing.getReadAs(int index) Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.com.google.protobuf.ByteStringgetReadAsBytes(int index) Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.intSet of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.com.google.protobuf.ProtocolStringListSet of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.intMust be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optionalcom.google.protobuf.ByteStringMust be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen OptionalintThe maximum number of passes for the Topology-Aware Package Selection (TAPS).Uniquely identifies the participant user that prepares the transaction.com.google.protobuf.ByteStringUniquely identifies the participant user that prepares the transaction.booleanWhen true, the response will contain additional details on how the transaction was encoded and hashed This can be useful for troubleshooting of hash mismatches.booleanHints to improve the accuracy of traffic cost estimation.booleanThe hashing scheme version to be used when building the hash.inthashCode()booleanMaximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.booleanOptionalbooleanThe maximum number of passes for the Topology-Aware Package Selection (TAPS).protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER- See Also:
-
COMMAND_ID_FIELD_NUMBER
public static final int COMMAND_ID_FIELD_NUMBER- See Also:
-
COMMANDS_FIELD_NUMBER
public static final int COMMANDS_FIELD_NUMBER- See Also:
-
MIN_LEDGER_TIME_FIELD_NUMBER
public static final int MIN_LEDGER_TIME_FIELD_NUMBER- See Also:
-
MAX_RECORD_TIME_FIELD_NUMBER
public static final int MAX_RECORD_TIME_FIELD_NUMBER- See Also:
-
ACT_AS_FIELD_NUMBER
public static final int ACT_AS_FIELD_NUMBER- See Also:
-
READ_AS_FIELD_NUMBER
public static final int READ_AS_FIELD_NUMBER- See Also:
-
DISCLOSED_CONTRACTS_FIELD_NUMBER
public static final int DISCLOSED_CONTRACTS_FIELD_NUMBER- See Also:
-
SYNCHRONIZER_ID_FIELD_NUMBER
public static final int SYNCHRONIZER_ID_FIELD_NUMBER- See Also:
-
PACKAGE_ID_SELECTION_PREFERENCE_FIELD_NUMBER
public static final int PACKAGE_ID_SELECTION_PREFERENCE_FIELD_NUMBER- See Also:
-
VERBOSE_HASHING_FIELD_NUMBER
public static final int VERBOSE_HASHING_FIELD_NUMBER- See Also:
-
PREFETCH_CONTRACT_KEYS_FIELD_NUMBER
public static final int PREFETCH_CONTRACT_KEYS_FIELD_NUMBER- See Also:
-
ESTIMATE_TRAFFIC_COST_FIELD_NUMBER
public static final int ESTIMATE_TRAFFIC_COST_FIELD_NUMBER- See Also:
-
HASHING_SCHEME_VERSION_FIELD_NUMBER
public static final int HASHING_SCHEME_VERSION_FIELD_NUMBER- See Also:
-
TAPS_MAX_PASSES_FIELD_NUMBER
public static final int TAPS_MAX_PASSES_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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. Optional
string user_id = 1;- Specified by:
getUserIdin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The userId.
-
getUserIdBytes
public 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. Optional
string user_id = 1;- Specified by:
getUserIdBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The bytes for userId.
-
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;- Specified by:
getCommandIdin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The commandId.
-
getCommandIdBytes
public 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;- Specified by:
getCommandIdBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The bytes for commandId.
-
getCommandsList
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty
repeated .com.daml.ledger.api.v2.Command commands = 3;- Specified by:
getCommandsListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getCommandsOrBuilderList
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty
repeated .com.daml.ledger.api.v2.Command commands = 3;- Specified by:
getCommandsOrBuilderListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getCommandsCount
public int getCommandsCount()Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty
repeated .com.daml.ledger.api.v2.Command commands = 3;- Specified by:
getCommandsCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getCommands
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty
repeated .com.daml.ledger.api.v2.Command commands = 3;- Specified by:
getCommandsin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getCommandsOrBuilder
Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty
repeated .com.daml.ledger.api.v2.Command commands = 3;- Specified by:
getCommandsOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
hasMinLedgerTime
public boolean hasMinLedgerTime()Optional
.com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4;- Specified by:
hasMinLedgerTimein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- Whether the minLedgerTime field is set.
-
getMinLedgerTime
Optional
.com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4;- Specified by:
getMinLedgerTimein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The minLedgerTime.
-
getMinLedgerTimeOrBuilder
Optional
.com.daml.ledger.api.v2.interactive.MinLedgerTime min_ledger_time = 4;- Specified by:
getMinLedgerTimeOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
hasMaxRecordTime
public boolean hasMaxRecordTime()Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
optional .google.protobuf.Timestamp max_record_time = 11;- Specified by:
hasMaxRecordTimein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- Whether the maxRecordTime field is set.
-
getMaxRecordTime
public com.google.protobuf.Timestamp getMaxRecordTime()Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
optional .google.protobuf.Timestamp max_record_time = 11;- Specified by:
getMaxRecordTimein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The maxRecordTime.
-
getMaxRecordTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getMaxRecordTimeOrBuilder()Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional
optional .google.protobuf.Timestamp max_record_time = 11;- Specified by:
getMaxRecordTimeOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getActAsList
public com.google.protobuf.ProtocolStringList 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;- Specified by:
getActAsListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- A list containing the actAs.
-
getActAsCount
public 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;- Specified by:
getActAsCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The count of actAs.
-
getActAs
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;- Specified by:
getActAsin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The actAs at the given index.
-
getActAsBytes
public 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;- Specified by:
getActAsBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the actAs at the given index.
-
getReadAsList
public com.google.protobuf.ProtocolStringList 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: can be empty
repeated string read_as = 6;- Specified by:
getReadAsListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- A list containing the readAs.
-
getReadAsCount
public 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: can be empty
repeated string read_as = 6;- Specified by:
getReadAsCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The count of readAs.
-
getReadAs
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: can be empty
repeated string read_as = 6;- Specified by:
getReadAsin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The readAs at the given index.
-
getReadAsBytes
public 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: can be empty
repeated string read_as = 6;- Specified by:
getReadAsBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the readAs at the given index.
-
getDisclosedContractsList
Additional contracts used to resolve contract & contract key lookups. Optional: can be empty
repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7;- Specified by:
getDisclosedContractsListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getDisclosedContractsOrBuilderList
public List<? extends CommandsOuterClass.DisclosedContractOrBuilder> getDisclosedContractsOrBuilderList()Additional contracts used to resolve contract & contract key lookups. Optional: can be empty
repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7;- Specified by:
getDisclosedContractsOrBuilderListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getDisclosedContractsCount
public int getDisclosedContractsCount()Additional contracts used to resolve contract & contract key lookups. Optional: can be empty
repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7;- Specified by:
getDisclosedContractsCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getDisclosedContracts
Additional contracts used to resolve contract & contract key lookups. Optional: can be empty
repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7;- Specified by:
getDisclosedContractsin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getDisclosedContractsOrBuilder
Additional contracts used to resolve contract & contract key lookups. Optional: can be empty
repeated .com.daml.ledger.api.v2.DisclosedContract disclosed_contracts = 7;- Specified by:
getDisclosedContractsOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getSynchronizerId
Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional
string synchronizer_id = 8;- Specified by:
getSynchronizerIdin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The synchronizerId.
-
getSynchronizerIdBytes
public com.google.protobuf.ByteString getSynchronizerIdBytes()Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional
string synchronizer_id = 8;- Specified by:
getSynchronizerIdBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The bytes for synchronizerId.
-
getPackageIdSelectionPreferenceList
public com.google.protobuf.ProtocolStringList getPackageIdSelectionPreferenceList()The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be empty
repeated string package_id_selection_preference = 9;- Specified by:
getPackageIdSelectionPreferenceListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- A list containing the packageIdSelectionPreference.
-
getPackageIdSelectionPreferenceCount
public int getPackageIdSelectionPreferenceCount()The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be empty
repeated string package_id_selection_preference = 9;- Specified by:
getPackageIdSelectionPreferenceCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The count of packageIdSelectionPreference.
-
getPackageIdSelectionPreference
The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be empty
repeated string package_id_selection_preference = 9;- Specified by:
getPackageIdSelectionPreferencein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The packageIdSelectionPreference at the given index.
-
getPackageIdSelectionPreferenceBytes
public 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 Optional: can be empty
repeated string package_id_selection_preference = 9;- Specified by:
getPackageIdSelectionPreferenceBytesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the packageIdSelectionPreference at the given index.
-
getVerboseHashing
public 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. Defaults to false Optional
bool verbose_hashing = 10;- Specified by:
getVerboseHashingin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The verboseHashing.
-
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: can be empty
repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15;- Specified by:
getPrefetchContractKeysListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getPrefetchContractKeysOrBuilderList
public 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: can be empty
repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15;- Specified by:
getPrefetchContractKeysOrBuilderListin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getPrefetchContractKeysCount
public 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: can be empty
repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15;- Specified by:
getPrefetchContractKeysCountin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getPrefetchContractKeys
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: can be empty
repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15;- Specified by:
getPrefetchContractKeysin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
getPrefetchContractKeysOrBuilder
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: can be empty
repeated .com.daml.ledger.api.v2.PrefetchContractKey prefetch_contract_keys = 15;- Specified by:
getPrefetchContractKeysOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
hasEstimateTrafficCost
public boolean hasEstimateTrafficCost()Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true Optional
optional .com.daml.ledger.api.v2.interactive.CostEstimationHints estimate_traffic_cost = 16;- Specified by:
hasEstimateTrafficCostin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- Whether the estimateTrafficCost field is set.
-
getEstimateTrafficCost
Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true Optional
optional .com.daml.ledger.api.v2.interactive.CostEstimationHints estimate_traffic_cost = 16;- Specified by:
getEstimateTrafficCostin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The estimateTrafficCost.
-
getEstimateTrafficCostOrBuilder
public InteractiveSubmissionServiceOuterClass.CostEstimationHintsOrBuilder getEstimateTrafficCostOrBuilder()Hints to improve the accuracy of traffic cost estimation. The estimation logic assumes that this node will be used for the execution of the transaction If another node is used instead, the estimation may be less precise. Request amplification is not accounted for in the estimation: each amplified request will result in the cost of the confirmation request to be charged additionally. Traffic cost estimation is enabled by default if this field is not set To turn off cost estimation, set the CostEstimationHints#disabled field to true Optional
optional .com.daml.ledger.api.v2.interactive.CostEstimationHints estimate_traffic_cost = 16;- Specified by:
getEstimateTrafficCostOrBuilderin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder
-
hasHashingSchemeVersion
public boolean hasHashingSchemeVersion()The hashing scheme version to be used when building the hash. Defaults to HASHING_SCHEME_VERSION_V2. Optional
optional .com.daml.ledger.api.v2.interactive.HashingSchemeVersion hashing_scheme_version = 17;- Specified by:
hasHashingSchemeVersionin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- Whether the hashingSchemeVersion field is set.
-
getHashingSchemeVersionValue
public int getHashingSchemeVersionValue()The hashing scheme version to be used when building the hash. Defaults to HASHING_SCHEME_VERSION_V2. Optional
optional .com.daml.ledger.api.v2.interactive.HashingSchemeVersion hashing_scheme_version = 17;- Specified by:
getHashingSchemeVersionValuein interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The enum numeric value on the wire for hashingSchemeVersion.
-
getHashingSchemeVersion
The hashing scheme version to be used when building the hash. Defaults to HASHING_SCHEME_VERSION_V2. Optional
optional .com.daml.ledger.api.v2.interactive.HashingSchemeVersion hashing_scheme_version = 17;- Specified by:
getHashingSchemeVersionin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The hashingSchemeVersion.
-
hasTapsMaxPasses
public boolean hasTapsMaxPasses()The maximum number of passes for the Topology-Aware Package Selection (TAPS). Higher values can increase the chance of successful package selection for routing of interpreted transactions. If unset, this defaults to the value defined in the participant configuration. The provided value must not exceed the limit specified in the participant configuration. Optional
optional uint32 taps_max_passes = 18;- Specified by:
hasTapsMaxPassesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- Whether the tapsMaxPasses field is set.
-
getTapsMaxPasses
public int getTapsMaxPasses()The maximum number of passes for the Topology-Aware Package Selection (TAPS). Higher values can increase the chance of successful package selection for routing of interpreted transactions. If unset, this defaults to the value defined in the participant configuration. The provided value must not exceed the limit specified in the participant configuration. Optional
optional uint32 taps_max_passes = 18;- Specified by:
getTapsMaxPassesin interfaceInteractiveSubmissionServiceOuterClass.PrepareSubmissionRequestOrBuilder- Returns:
- The tapsMaxPasses.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest.Builder newBuilder(InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
public static com.google.protobuf.Parser<InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest> parser() -
getParserForType
public com.google.protobuf.Parser<InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest> getParserForType()- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-