Interface ListRecipientsRequest

interface ListRecipientsRequest {
    dataRecipientGlobalMetastoreId?: string;
    maxResults?: number;
    pageToken?: string;
}

Properties

dataRecipientGlobalMetastoreId?: string

If not provided, all recipients will be returned. If no recipients exist with this ID, no results will be returned.

maxResults?: number

Maximum number of recipients to return.

when set to 0, the page length is set to a server configured value (recommended);
when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
when set to a value less than 0, an invalid parameter error is returned;
If not set, all valid recipients are returned (not recommended).
Note: The number of returned recipients might be less than the specified max_results size, even zero. The only definitive indication that no further recipients can be fetched is when the next_page_token is unset from the response.

pageToken?: string

Opaque pagination token to go to next page based on previous query.