Package com.daml.ledger.api.v2.admin

Interface PartyManagementServiceOuterClass.AllocateExternalPartyRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartyManagementServiceOuterClass.AllocateExternalPartyRequest, PartyManagementServiceOuterClass.AllocateExternalPartyRequest.Builder
Enclosing class:
PartyManagementServiceOuterClass
public static interface PartyManagementServiceOuterClass.AllocateExternalPartyRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSynchronizer

      String getSynchronizer()
       TODO(#27670) support synchronizer aliases
 Synchronizer ID on which to onboard the party

 Required
      string synchronizer = 1;
      Returns:
      The synchronizer.

    • getSynchronizerBytes

      com.google.protobuf.ByteString getSynchronizerBytes()
       TODO(#27670) support synchronizer aliases
 Synchronizer ID on which to onboard the party

 Required
      string synchronizer = 1;
      Returns:
      The bytes for synchronizer.

    • getOnboardingTransactionsList

      List<PartyManagementServiceOuterClass.AllocateExternalPartyRequest.SignedTransaction> getOnboardingTransactionsList()
       TopologyTransactions to onboard the external party
 Can contain:
 - A namespace for the party.
 This can be either a single NamespaceDelegation,
 or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
 May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
 - A PartyToParticipant to register the hosting relationship of the party, and the party's signing keys and threshold.
 Must be provided.

 Required: must be non-empty
      repeated .com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction onboarding_transactions = 2;

    • getOnboardingTransactions

      PartyManagementServiceOuterClass.AllocateExternalPartyRequest.SignedTransaction getOnboardingTransactions(int index)
       TopologyTransactions to onboard the external party
 Can contain:
 - A namespace for the party.
 This can be either a single NamespaceDelegation,
 or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
 May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
 - A PartyToParticipant to register the hosting relationship of the party, and the party's signing keys and threshold.
 Must be provided.

 Required: must be non-empty
      repeated .com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction onboarding_transactions = 2;

    • getOnboardingTransactionsCount

      int getOnboardingTransactionsCount()
       TopologyTransactions to onboard the external party
 Can contain:
 - A namespace for the party.
 This can be either a single NamespaceDelegation,
 or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
 May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
 - A PartyToParticipant to register the hosting relationship of the party, and the party's signing keys and threshold.
 Must be provided.

 Required: must be non-empty
      repeated .com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction onboarding_transactions = 2;

    • getOnboardingTransactionsOrBuilderList

      List<? extends PartyManagementServiceOuterClass.AllocateExternalPartyRequest.SignedTransactionOrBuilder> getOnboardingTransactionsOrBuilderList()
       TopologyTransactions to onboard the external party
 Can contain:
 - A namespace for the party.
 This can be either a single NamespaceDelegation,
 or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
 May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
 - A PartyToParticipant to register the hosting relationship of the party, and the party's signing keys and threshold.
 Must be provided.

 Required: must be non-empty
      repeated .com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction onboarding_transactions = 2;

    • getOnboardingTransactionsOrBuilder

      PartyManagementServiceOuterClass.AllocateExternalPartyRequest.SignedTransactionOrBuilder getOnboardingTransactionsOrBuilder(int index)
       TopologyTransactions to onboard the external party
 Can contain:
 - A namespace for the party.
 This can be either a single NamespaceDelegation,
 or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
 May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
 - A PartyToParticipant to register the hosting relationship of the party, and the party's signing keys and threshold.
 Must be provided.

 Required: must be non-empty
      repeated .com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction onboarding_transactions = 2;

    • getMultiHashSignaturesList

      List<CryptoOuterClass.Signature> getMultiHashSignaturesList()
       Optional signatures of the combined hash of all onboarding_transactions
 This may be used instead of providing signatures on each individual transaction

 Optional: can be empty
      repeated .com.daml.ledger.api.v2.Signature multi_hash_signatures = 3;

    • getMultiHashSignatures

      CryptoOuterClass.Signature getMultiHashSignatures(int index)
       Optional signatures of the combined hash of all onboarding_transactions
 This may be used instead of providing signatures on each individual transaction

 Optional: can be empty
      repeated .com.daml.ledger.api.v2.Signature multi_hash_signatures = 3;

    • getMultiHashSignaturesCount

      int getMultiHashSignaturesCount()
       Optional signatures of the combined hash of all onboarding_transactions
 This may be used instead of providing signatures on each individual transaction

 Optional: can be empty
      repeated .com.daml.ledger.api.v2.Signature multi_hash_signatures = 3;

    • getMultiHashSignaturesOrBuilderList

      List<? extends CryptoOuterClass.SignatureOrBuilder> getMultiHashSignaturesOrBuilderList()
       Optional signatures of the combined hash of all onboarding_transactions
 This may be used instead of providing signatures on each individual transaction

 Optional: can be empty
      repeated .com.daml.ledger.api.v2.Signature multi_hash_signatures = 3;

    • getMultiHashSignaturesOrBuilder

      CryptoOuterClass.SignatureOrBuilder getMultiHashSignaturesOrBuilder(int index)
       Optional signatures of the combined hash of all onboarding_transactions
 This may be used instead of providing signatures on each individual transaction

 Optional: can be empty
      repeated .com.daml.ledger.api.v2.Signature multi_hash_signatures = 3;

    • getIdentityProviderId

      String getIdentityProviderId()
       The id of the ``Identity Provider``
 If not set, assume the party is managed by the default identity provider.

 Optional
      string identity_provider_id = 4;
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The id of the ``Identity Provider``
 If not set, assume the party is managed by the default identity provider.

 Optional
      string identity_provider_id = 4;
      Returns:
      The bytes for identityProviderId.

    • hasWaitForAllocation

      boolean hasWaitForAllocation()
       When true, this RPC will attempt to wait for the party to be allocated on the synchronizer before returning.
 When false, the allocation will happen asynchronously.
 This is a best effort only as this synchronization is only possible for non decentralized parties (single hosting node).
 For decentralized parties, this flag is ignored.
 Defaults to true.

 Optional
      optional bool wait_for_allocation = 5;
      Returns:
      Whether the waitForAllocation field is set.

    • getWaitForAllocation

      boolean getWaitForAllocation()
       When true, this RPC will attempt to wait for the party to be allocated on the synchronizer before returning.
 When false, the allocation will happen asynchronously.
 This is a best effort only as this synchronization is only possible for non decentralized parties (single hosting node).
 For decentralized parties, this flag is ignored.
 Defaults to true.

 Optional
      optional bool wait_for_allocation = 5;
      Returns:
      The waitForAllocation.

    • getUserId

      String getUserId()
       The user who will get the act_as rights to the newly allocated party.
 If set to an empty string (the default), no user will get rights to the party.

 Optional
      string user_id = 6;
      Returns:
      The userId.

    • getUserIdBytes

      com.google.protobuf.ByteString getUserIdBytes()
       The user who will get the act_as rights to the newly allocated party.
 If set to an empty string (the default), no user will get rights to the party.

 Optional
      string user_id = 6;
      Returns:
      The bytes for userId.