Struct elasticsearch::transform::TransformStopTransform

pub struct TransformStopTransform<'a, 'b, B> { /* private fields */ }

Builder for the Transform Stop Transform API

Stops one or more transforms.

Implementations

impl<'a, 'b, B> TransformStopTransform<'a, 'b, B>where
    B: Body,

pub fn new(
    transport: &'a Transport,
    parts: TransformStopTransformParts<'b>
) -> Self

Creates a new instance of TransformStopTransform with the specified API parts

pub fn allow_no_match(self, allow_no_match: bool) -> Self

Whether to ignore if a wildcard expression matches no transforms. (This includes _all string or when no transforms have been specified)

pub fn body<T>(self, body: T) -> TransformStopTransform<'a, 'b, JsonBody<T>>where
    T: Serialize,

The body for the API call

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn force(self, force: bool) -> Self

Whether to force stop a failed transform or not. Default to false

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn timeout(self, timeout: &'b str) -> Self

Controls the time to wait until the transform has stopped. Default to 30 seconds

pub fn wait_for_checkpoint(self, wait_for_checkpoint: bool) -> Self

Whether to wait for the transform to reach a checkpoint before stopping. Default to false

pub fn wait_for_completion(self, wait_for_completion: bool) -> Self

Whether to wait for the transform to fully stop before returning or not. Default to false

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Transform Stop Transform API that can be awaited

Trait Implementations

impl<'a, 'b, B: Clone> Clone for TransformStopTransform<'a, 'b, B>

fn clone(&self) -> TransformStopTransform<'a, 'b, B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for TransformStopTransform<'a, 'b, B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.