commonMain.com.algolia.client.model.search.GetObjectsRequest.kt Maven / Gradle / Ivy

Go to download
/** 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.*

/**
 * Request body for retrieving records.
 *
 * @param objectID Object ID for the record to retrieve.
 * @param indexName Index from which to retrieve the records.
 * @param attributesToRetrieve Attributes to retrieve. If not specified, all retrievable attributes are returned.
 */
@Serializable
public data class GetObjectsRequest(

  /** Object ID for the record to retrieve. */
  @SerialName(value = "objectID") val objectID: String,

  /** Index from which to retrieve the records. */
  @SerialName(value = "indexName") val indexName: String,

  /** Attributes to retrieve. If not specified, all retrievable attributes are returned.  */
  @SerialName(value = "attributesToRetrieve") val attributesToRetrieve: List? = null,
)