commonMain.com.algolia.client.transport.RequestOptions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-client-kotlin Show documentation

"Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search REST API from your JVM project, such as Android or backend implementations."

There is a newer version: 3.10.1

Show newest version

package com.algolia.client.transport

import kotlinx.serialization.json.JsonObject
import kotlin.time.Duration

/**
 * Represents options for configuring a request to an endpoint.
 *
 * @property writeTimeout The write timeout for the request in milliseconds.
 * @property readTimeout The read timeout for the request in milliseconds.
 * @property headers A mutable map of header names to their respective values to be sent with the request.
 * @property urlParameters A mutable map of URL parameter names to their respective values to be appended to the request URL.
 * @property body A JSON object representing the request body.
 */
public data class RequestOptions(
  public val writeTimeout: Duration? = null,
  public val readTimeout: Duration? = null,
  public val headers: Map = emptyMap(),
  public val urlParameters: Map = emptyMap(),
  public val body: JsonObject? = null,
)