Struct AllocatePartyRequest 

pub struct AllocatePartyRequest {
    pub party_id_hint: String,
    pub local_metadata: Option<ObjectMeta>,
    pub identity_provider_id: String,
    pub synchronizer_id: String,
    pub user_id: String,
}

Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)

Fields

party_id_hint: String

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

local_metadata: Option<ObjectMeta>

Participant-local metadata to be stored in the PartyDetails of this newly allocated party.

Optional

identity_provider_id: String

The id of the Identity Provider If not set, assume the party is managed by the default identity provider or party is not hosted by the participant.

Optional

synchronizer_id: String

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

user_id: String

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

Trait Implementations

impl Clone for AllocatePartyRequest

fn clone(&self) -> AllocatePartyRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AllocatePartyRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for AllocatePartyRequest

fn default() -> AllocatePartyRequest

Returns the “default value” for a type.

impl Message for AllocatePartyRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for AllocatePartyRequest

fn eq(&self, other: &AllocatePartyRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AllocatePartyRequest