Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CodelessConnectorPollingRequestProperties

Package version

Describe the request properties needed to successfully pull from the server

Hierarchy

  • CodelessConnectorPollingRequestProperties

Index

Properties

apiEndpoint

apiEndpoint: string

Describe the endpoint we should pull the data from

Optional endTimeAttributeName

endTimeAttributeName: undefined | string

This will be used the query events from the end of the time window

Optional headers

headers: Record<string, unknown>

Describe the headers sent in the poll request

httpMethod

httpMethod: string

The http method type we will use in the poll request, GET or POST

Optional queryParameters

queryParameters: Record<string, unknown>

Describe the query parameters sent in the poll request

Optional queryParametersTemplate

queryParametersTemplate: undefined | string

For advanced scenarios for example user name/password embedded in nested JSON payload

queryTimeFormat

queryTimeFormat: string

The time format will be used the query events in a specific window

queryWindowInMin

queryWindowInMin: number

The window interval we will use the pull the data

Optional rateLimitQps

rateLimitQps: undefined | number

Defines the rate limit QPS

Optional retryCount

retryCount: undefined | number

Describe the amount of time we should try and poll the data in case of failure

Optional startTimeAttributeName

startTimeAttributeName: undefined | string

This will be used the query events from a start of the time window

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The number of seconds we will consider as a request timeout

Generated using TypeDoc