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

/**
 * UserHit
 *
 * @param userID Unique identifier of the user who makes the search request.
 * @param clusterName Cluster name.
 * @param nbRecords Number of records in the cluster.
 * @param dataSize Data size taken by all the users assigned to the cluster.
 * @param objectID userID of the requested user. Same as userID.
 * @param highlightResult
 */
@Serializable
public data class UserHit(

  /** Unique identifier of the user who makes the search request. */
  @SerialName(value = "userID") val userID: String,

  /** Cluster name. */
  @SerialName(value = "clusterName") val clusterName: String,

  /** Number of records in the cluster. */
  @SerialName(value = "nbRecords") val nbRecords: Int,

  /** Data size taken by all the users assigned to the cluster. */
  @SerialName(value = "dataSize") val dataSize: Int,

  /** userID of the requested user. Same as userID. */
  @SerialName(value = "objectID") val objectID: String,

  @SerialName(value = "_highlightResult") val highlightResult: UserHighlightResult,
)