pinot-noir.pinotbrokerjsontransport.md

Home > pinot-noir > PinotBrokerJSONTransport

PinotBrokerJSONTransport class

Pinot broker JSON transport based on "undici" http client.

Signature:

export declare class PinotBrokerJSONTransport implements IPinotBrokerTransport

Implements: IPinotBrokerTransport

Constructors

Constructor	Modifiers	Description
(constructor)({ bodyTimeout, brokerUrl, connections, headersTimeout, keepAliveMaxTimeout, token, maxQueueSize, })		Constructs a new instance of the PinotBrokerJSONTransport class

Properties

Property	Modifiers	Type	Description
maxQueueSize	protected readonly	number | undefined	Maximum query queue size.
pool	protected readonly	Pool	HTTP client pool.
stats	readonly	IPinotPoolStats	HTTP pool statitstics
token	protected readonly	string	Pinot broker auth token.

Methods

Method	Modifiers	Description
close()		Closes connection to pinot broker
request({ body, headers, method, path, query, options, })		Perform HTTP request to pinot