Package com.daml.ledger.api.v1.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDisplayName()
Human-readable name of the party to be added to the participant.com.google.protobuf.ByteString
getDisplayNameBytes()
Human-readable name of the party to be added to the participant.java.lang.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.java.lang.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.boolean
hasLocalMetadata()
Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getPartyIdHint
java.lang.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.
-
getDisplayName
java.lang.String getDisplayName()
Human-readable name of the party to be added to the participant. It doesn't have to be unique. Use of this field is discouraged. Use ``local_metadata`` instead. Optional
string display_name = 2 [json_name = "displayName"];
- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()
Human-readable name of the party to be added to the participant. It doesn't have to be unique. Use of this field is discouraged. Use ``local_metadata`` instead. Optional
string display_name = 2 [json_name = "displayName"];
- Returns:
- The bytes for displayName.
-
hasLocalMetadata
boolean hasLocalMetadata()
Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party. Optional
.com.daml.ledger.api.v1.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.v1.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.v1.admin.ObjectMeta local_metadata = 3 [json_name = "localMetadata"];
-
getIdentityProviderId
java.lang.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.
-
-