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

Interface PartyManagementServiceOuterClass.ListKnownPartiesRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilterParty()
    An optional filter for the party name, searching for all party names known to this node starting with the given prefix.
    com.google.protobuf.ByteString
    getFilterPartyBytes()
    An optional filter for the party name, searching for all party names known to this node starting with the given prefix.
    String
    getIdentityProviderId()
    The id of the ``Identity Provider`` whose parties should be retrieved.
    com.google.protobuf.ByteString
    getIdentityProviderIdBytes()
    The id of the ``Identity Provider`` whose parties should be retrieved.
    int
    getPageSize()
    Maximum number of results to be returned by the server.
    String
    getPageToken()
    Pagination token to determine the specific page to fetch.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Pagination token to determine the specific page to fetch.

    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

    • getPageToken

      String getPageToken()
       Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent
 page are all lexically greater than the last party on a previous page. Server does not store intermediate results
 between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is
 requested twice using the same token, more parties can be returned on the second call.
 Leave empty to fetch the first page.

 Optional
      string page_token = 2;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Pagination token to determine the specific page to fetch. Using the token guarantees that parties on a subsequent
 page are all lexically greater than the last party on a previous page. Server does not store intermediate results
 between calls chained by a series of page tokens. As a consequence, if new parties are being added and a page is
 requested twice using the same token, more parties can be returned on the second call.
 Leave empty to fetch the first page.

 Optional
      string page_token = 2;
      Returns:
      The bytes for pageToken.

    • getPageSize

      int getPageSize()
       Maximum number of results to be returned by the server. The server will return no more than that many results,
 but it might return fewer. If the page_size is 0, the server will decide the number of results to be returned.
 If the page_size exceeds the maximum supported by the server, an error will be returned. To obtain the server's
 maximum consult the PartyManagementFeature descriptor available in the VersionService.

 Optional
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getIdentityProviderId

      String getIdentityProviderId()
       The id of the ``Identity Provider`` whose parties should be retrieved.
 If not set, assume the party is managed by the default identity provider or party is not hosted by the participant.

 Optional
      string identity_provider_id = 1;
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The id of the ``Identity Provider`` whose parties should be retrieved.
 If not set, assume the party is managed by the default identity provider or party is not hosted by the participant.

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

    • getFilterParty

      String getFilterParty()
       An optional filter for the party name, searching for all party names known to this node
 starting with the given prefix. This can either be just a string or extend up to the full
 identifier.

 Optional
      string filter_party = 4;
      Returns:
      The filterParty.

    • getFilterPartyBytes

      com.google.protobuf.ByteString getFilterPartyBytes()
       An optional filter for the party name, searching for all party names known to this node
 starting with the given prefix. This can either be just a string or extend up to the full
 identifier.

 Optional
      string filter_party = 4;
      Returns:
      The bytes for filterParty.