Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SuggestMatchesRequest

example

Click here to see how to use SuggestMatchesRequest.

Hierarchy

Properties

catalogId

catalogId: string

Unique catalog identifier.

inputText

inputText: string

Text input string used for computing potential matching suggestions.

Optional limit

limit: undefined | number

Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional timeout

timeout: undefined | string

A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.