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

Interface PartyManagementServiceOuterClass.PartyDetailsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIdentityProviderId()
    The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1.
    com.google.protobuf.ByteString
    getIdentityProviderIdBytes()
    The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1.
    boolean
    getIsLocal()
    true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.
    ObjectMetaOuterClass.ObjectMeta
    getLocalMetadata()
    Participant-local metadata of this party.
    ObjectMetaOuterClass.ObjectMetaOrBuilder
    getLocalMetadataOrBuilder()
    Participant-local metadata of this party.
    String
    getParty()
    The stable unique identifier of a Daml party.
    com.google.protobuf.ByteString
    getPartyBytes()
    The stable unique identifier of a Daml party.
    boolean
    hasLocalMetadata()
    Participant-local metadata of this 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

    • getParty

      String getParty()
       The stable unique identifier of a Daml party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
      string party = 1 [json_name = "party"];
      Returns:
      The party.

    • getPartyBytes

      com.google.protobuf.ByteString getPartyBytes()
       The stable unique identifier of a Daml party.
 Must be a valid PartyIdString (as described in ``value.proto``).
 Required
      string party = 1 [json_name = "party"];
      Returns:
      The bytes for party.

    • getIsLocal

      boolean getIsLocal()
       true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.
 Optional
      bool is_local = 3 [json_name = "isLocal"];
      Returns:
      The isLocal.

    • hasLocalMetadata

      boolean hasLocalMetadata()
       Participant-local metadata of this party.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 4 [json_name = "localMetadata"];
      Returns:
      Whether the localMetadata field is set.

    • getLocalMetadata

      ObjectMetaOuterClass.ObjectMeta getLocalMetadata()
       Participant-local metadata of this party.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 4 [json_name = "localMetadata"];
      Returns:
      The localMetadata.

    • getLocalMetadataOrBuilder

      ObjectMetaOuterClass.ObjectMetaOrBuilder getLocalMetadataOrBuilder()
       Participant-local metadata of this party.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta local_metadata = 4 [json_name = "localMetadata"];

    • getIdentityProviderId

      String getIdentityProviderId()
       The id of the ``Identity Provider``
 Optional, if not set, there could be 3 options:

 1. the party is managed by the default identity provider.
 2. party is not hosted by the participant.
 3. party is hosted by the participant, but is outside of the user's identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The id of the ``Identity Provider``
 Optional, if not set, there could be 3 options:

 1. the party is managed by the default identity provider.
 2. party is not hosted by the participant.
 3. party is hosted by the participant, but is outside of the user's identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Returns:
      The bytes for identityProviderId.