commonMain.com.algolia.client.model.search.SearchRulesParams.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

/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.search

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
 * Rules search parameters.
 *
 * @param query Search query for rules.
 * @param anchoring
 * @param context Only return rules that match the context (exact match).
 * @param page Requested page of the API response.
 * @param hitsPerPage Maximum number of hits per page.
 * @param enabled If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
 */
@Serializable
public data class SearchRulesParams(

  /** Search query for rules. */
  @SerialName(value = "query") val query: String? = null,

  @SerialName(value = "anchoring") val anchoring: Anchoring? = null,

  /** Only return rules that match the context (exact match). */
  @SerialName(value = "context") val context: String? = null,

  /** Requested page of the API response. */
  @SerialName(value = "page") val page: Int? = null,

  /** Maximum number of hits per page. */
  @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null,

  /** If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.  */
  @SerialName(value = "enabled") val enabled: Boolean? = null,
)