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

Interface PartyManagementServiceOuterClass.AllocatePartyRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIdentityProviderId()
    The id of the ``Identity Provider`` Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
    com.google.protobuf.ByteString
    getIdentityProviderIdBytes()
    The id of the ``Identity Provider`` Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
    ObjectMetaOuterClass.ObjectMeta
    getLocalMetadata()
    Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
    ObjectMetaOuterClass.ObjectMetaOrBuilder
    getLocalMetadataOrBuilder()
    Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
    String
    getPartyIdHint()
    A hint to the participant which party ID to allocate.
    com.google.protobuf.ByteString
    getPartyIdHintBytes()
    A hint to the participant which party ID to allocate.
    String
    getSynchronizerId()
    The synchronizer, on which the party should be allocated.
    com.google.protobuf.ByteString
    getSynchronizerIdBytes()
    The synchronizer, on which the party should be allocated.
    String
    getUserId()
    The user who will get the act_as rights to the newly allocated party.
    com.google.protobuf.ByteString
    getUserIdBytes()
    The user who will get the act_as rights to the newly allocated party.
    boolean
    hasLocalMetadata()
    Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPartyIdHint

      String getPartyIdHint()
       A hint to the participant which party ID to allocate. It can be
 ignored.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Optional
      string party_id_hint = 1 [json_name = "partyIdHint"];
      Returns:
      The partyIdHint.

    • getPartyIdHintBytes

      com.google.protobuf.ByteString getPartyIdHintBytes()
       A hint to the participant which party ID to allocate. It can be
 ignored.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Optional
      string party_id_hint = 1 [json_name = "partyIdHint"];
      Returns:
      The bytes for partyIdHint.

    • hasLocalMetadata

      boolean hasLocalMetadata()
       Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
 Optional
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 3 [json_name = "localMetadata"];
      Returns:
      Whether the localMetadata field is set.

    • getLocalMetadata

      ObjectMetaOuterClass.ObjectMeta getLocalMetadata()
       Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
 Optional
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 3 [json_name = "localMetadata"];
      Returns:
      The localMetadata.

    • getLocalMetadataOrBuilder

      ObjectMetaOuterClass.ObjectMetaOrBuilder getLocalMetadataOrBuilder()
       Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
 Optional
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 3 [json_name = "localMetadata"];

    • getIdentityProviderId

      String getIdentityProviderId()
       The id of the ``Identity Provider``
 Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
      string identity_provider_id = 4 [json_name = "identityProviderId"];
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The id of the ``Identity Provider``
 Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
      string identity_provider_id = 4 [json_name = "identityProviderId"];
      Returns:
      The bytes for identityProviderId.

    • getSynchronizerId

      String getSynchronizerId()
       The synchronizer, on which the party should be allocated.
 For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer.
 Otherwise a synchronizer must be specified.
 Optional
      string synchronizer_id = 5 [json_name = "synchronizerId"];
      Returns:
      The synchronizerId.

    • getSynchronizerIdBytes

      com.google.protobuf.ByteString getSynchronizerIdBytes()
       The synchronizer, on which the party should be allocated.
 For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer.
 Otherwise a synchronizer must be specified.
 Optional
      string synchronizer_id = 5 [json_name = "synchronizerId"];
      Returns:
      The bytes for synchronizerId.

    • 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 [json_name = "userId"];
      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 [json_name = "userId"];
      Returns:
      The bytes for userId.