ListIndexStatsSummaryOptions interface

Package:
@azure/search-documents

Options for list index stats summary operation.

Extends
OperationOptions

Properties

pageSize

The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.
search

A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.
searchType

Specifies how the search parameter is interpreted. Currently only prefix is supported.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Property Details

pageSize

The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.

pageSize?: number

Property Value

number

A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.

search?: string

Property Value

string

searchType

Specifies how the search parameter is interpreted. Currently only prefix is supported.

searchType?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions