Interface HttpClient

HttpClient interface can be used for providing a custom client responsible for executing GET and POST requests against Pinot Controllers and Brokers.

Hierarchy

HttpClient

Index

Properties

Properties

get

get: (<T>(url: string, options: { headers: Record<string, string> }) => Promise<HttpClientResponse<T>>)

Type declaration

- <T>(url: string, options: { headers: Record<string, string> }): Promise<HttpClientResponse<T>>
- Executes a HTTP GET request at a specified url. Used for sending requests to Pinot Controllers.
  Type Parameters
  - T
  Parameters
  - url: string
  - options: { headers: Record<string, string> }
    - headers: Record<string, string>
  Returns Promise<HttpClientResponse<T>>

post

post: (<T>(url: string, data: object, options: { headers: Record<string, string> }) => Promise<HttpClientResponse<T>>)

Type declaration

- <T>(url: string, data: object, options: { headers: Record<string, string> }): Promise<HttpClientResponse<T>>
- Executes a HTTP POST request at a specified url Used for querying Pinot Brokers.
  Type Parameters
  - T
  Parameters
  - url: string
  - data: object
  - options: { headers: Record<string, string> }
    - headers: Record<string, string>
  Returns Promise<HttpClientResponse<T>>

Generated using TypeDoc