com.sksamuel.elastic4s.requests.update.UpdateByQueryRequest.scala Maven / Gradle / Ivy
The newest version!
package com.sksamuel.elastic4s.requests.update
import com.sksamuel.elastic4s.Indexes
import com.sksamuel.elastic4s.requests.common.{RefreshPolicy, Slice, Slicing}
import com.sksamuel.elastic4s.requests.script.Script
import com.sksamuel.elastic4s.requests.searches.queries.Query
import com.sksamuel.elastic4s.ext.OptionImplicits._
import com.sksamuel.elastic4s.requests.admin.IndicesOptionsRequest
import scala.concurrent.duration.FiniteDuration
trait BaseUpdateByQueryRequest {
val indexes: Indexes
val query: Query
val requestsPerSecond: Option[Float]
val maxRetries: Option[Int]
val proceedOnConflicts: Option[Boolean]
val pipeline: Option[String]
val refresh: Option[RefreshPolicy]
val script: Option[Script]
val waitForActiveShards: Option[Int]
val retryBackoffInitialTime: Option[FiniteDuration]
val scroll: Option[String]
val scrollSize: Option[Int]
val slices: Option[Int]
val slice: Option[Slice]
val timeout: Option[FiniteDuration]
val shouldStoreResult: Option[Boolean]
val size: Option[Int]
val waitForCompletion: Option[Boolean]
val indicesOptions: Option[IndicesOptionsRequest]
}
case class UpdateByQueryRequest(indexes: Indexes,
query: Query,
requestsPerSecond: Option[Float] = None,
maxRetries: Option[Int] = None,
proceedOnConflicts: Option[Boolean] = None,
pipeline: Option[String] = None,
refresh: Option[RefreshPolicy] = None,
script: Option[Script] = None,
waitForActiveShards: Option[Int] = None,
@deprecated("This class is for synchronous updates. If you put false, use UpdateByQueryAsyncRequest instead", "8.4")
waitForCompletion: Option[Boolean] = None,
retryBackoffInitialTime: Option[FiniteDuration] = None,
scroll: Option[String] = None,
scrollSize: Option[Int] = None,
slices: Option[Int] = None,
slice: Option[Slice] = None,
timeout: Option[FiniteDuration] = None,
shouldStoreResult: Option[Boolean] = None,
size: Option[Int] = None,
indicesOptions: Option[IndicesOptionsRequest] = None) extends BaseUpdateByQueryRequest {
def proceedOnConflicts(proceedOnConflicts: Boolean): UpdateByQueryRequest =
copy(proceedOnConflicts = proceedOnConflicts.some)
def refresh(refresh: RefreshPolicy): UpdateByQueryRequest = {
if (refresh == RefreshPolicy.WAIT_FOR) throw new UnsupportedOperationException("Update by query does not support RefreshPolicy.WAIT_FOR")
copy(refresh = refresh.some)
}
def refreshImmediately: UpdateByQueryRequest = refresh(RefreshPolicy.IMMEDIATE)
def scroll(scroll: String): UpdateByQueryRequest = copy(scroll = scroll.some)
def scroll(duration: FiniteDuration): UpdateByQueryRequest = copy(scroll = s"${duration.toSeconds}s".some)
def scrollSize(scrollSize: Int): UpdateByQueryRequest = copy(scrollSize = scrollSize.some)
def slice(slice: Slice): UpdateByQueryRequest = copy(slice = slice.some)
def slices(slices: Int): UpdateByQueryRequest = copy(slices = slices.some)
def automaticSlicing(): UpdateByQueryRequest = copy(slices = Some(Slicing.AutoSlices))
def requestsPerSecond(requestsPerSecond: Float): UpdateByQueryRequest =
copy(requestsPerSecond = requestsPerSecond.some)
def maxRetries(maxRetries: Int): UpdateByQueryRequest = copy(maxRetries = maxRetries.some)
def waitForActiveShards(waitForActiveShards: Int): UpdateByQueryRequest =
copy(waitForActiveShards = waitForActiveShards.some)
@deprecated("This class is for synchronous updates. If you put false, use UpdateByQueryAsyncRequest instead", "8.4")
def waitForCompletion(w: Boolean): UpdateByQueryRequest = copy(waitForCompletion = w.some)
def retryBackoffInitialTime(retryBackoffInitialTime: FiniteDuration): UpdateByQueryRequest =
copy(retryBackoffInitialTime = retryBackoffInitialTime.some)
def timeout(timeout: FiniteDuration): UpdateByQueryRequest = copy(timeout = timeout.some)
def size(size: Int): UpdateByQueryRequest = copy(size = size.some)
def script(script: Script): UpdateByQueryRequest = copy(script = script.some)
def script(source: String): UpdateByQueryRequest = script(Script(source))
def shouldStoreResult(shouldStoreResult: Boolean): UpdateByQueryRequest =
copy(shouldStoreResult = shouldStoreResult.some)
def indicesOptions(options: IndicesOptionsRequest): UpdateByQueryRequest = copy(indicesOptions = options.some)
}