RestApiPollerRequestConfigArgs

data class RestApiPollerRequestConfigArgs(val apiEndpoint: Output<String>, val endTimeAttributeName: Output<String>? = null, val headers: Output<Map<String, String>>? = null, val httpMethod: Output<Either<String, HttpMethodVerb>>? = null, val isPostPayloadJson: Output<Boolean>? = null, val queryParameters: Output<Any>? = null, val queryParametersTemplate: Output<String>? = null, val queryTimeFormat: Output<String>? = null, val queryTimeIntervalAttributeName: Output<String>? = null, val queryTimeIntervalDelimiter: Output<String>? = null, val queryTimeIntervalPrepend: Output<String>? = null, val queryWindowInMin: Output<Int>? = null, val rateLimitQPS: Output<Int>? = null, val retryCount: Output<Int>? = null, val startTimeAttributeName: Output<String>? = null, val timeoutInSeconds: Output<Int>? = null) : ConvertibleToJava<RestApiPollerRequestConfigArgs>

The request configuration.

Constructors

Link copied to clipboard
constructor(apiEndpoint: Output<String>, endTimeAttributeName: Output<String>? = null, headers: Output<Map<String, String>>? = null, httpMethod: Output<Either<String, HttpMethodVerb>>? = null, isPostPayloadJson: Output<Boolean>? = null, queryParameters: Output<Any>? = null, queryParametersTemplate: Output<String>? = null, queryTimeFormat: Output<String>? = null, queryTimeIntervalAttributeName: Output<String>? = null, queryTimeIntervalDelimiter: Output<String>? = null, queryTimeIntervalPrepend: Output<String>? = null, queryWindowInMin: Output<Int>? = null, rateLimitQPS: Output<Int>? = null, retryCount: Output<Int>? = null, startTimeAttributeName: Output<String>? = null, timeoutInSeconds: Output<Int>? = null)

Properties

Link copied to clipboard
val apiEndpoint: Output<String>

The API endpoint.

Link copied to clipboard
val endTimeAttributeName: Output<String>? = null

The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName

Link copied to clipboard
val headers: Output<Map<String, String>>? = null

The header for the request for the remote server.

Link copied to clipboard
val httpMethod: Output<Either<String, HttpMethodVerb>>? = null

The HTTP method, default value GET.

Link copied to clipboard
val isPostPayloadJson: Output<Boolean>? = null

Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).

Link copied to clipboard
val queryParameters: Output<Any>? = null

The HTTP query parameters to RESTful API.

Link copied to clipboard
val queryParametersTemplate: Output<String>? = null

the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.

Link copied to clipboard
val queryTimeFormat: Output<String>? = null

The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.

Link copied to clipboard

The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter

Link copied to clipboard
val queryTimeIntervalDelimiter: Output<String>? = null

The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.

Link copied to clipboard
val queryTimeIntervalPrepend: Output<String>? = null

The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.

Link copied to clipboard
val queryWindowInMin: Output<Int>? = null

The query window in minutes for the request.

Link copied to clipboard
val rateLimitQPS: Output<Int>? = null

The Rate limit queries per second for the request..

Link copied to clipboard
val retryCount: Output<Int>? = null

The retry count.

Link copied to clipboard
val startTimeAttributeName: Output<String>? = null

The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.

Link copied to clipboard
val timeoutInSeconds: Output<Int>? = null

The timeout in seconds.

Functions

Link copied to clipboard
open override fun toJava(): RestApiPollerRequestConfigArgs