Struct elasticsearch::text_structure::TextStructureFindStructure

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

Builder for the Text Structure Find Structure API

Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.

Implementations

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

pub fn new(transport: &'a Transport) -> Self

Creates a new instance of TextStructureFindStructure

pub fn body<T>(
    self,
    body: Vec<T>
) -> TextStructureFindStructure<'a, 'b, NdBody<T>>where
    T: Body,

The body for the API call

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

Optional parameter to specify the character set of the file

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

Optional parameter containing a comma separated list of the column names for a delimited file

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

Optional parameter to specify the delimiter character for a delimited file - must be a single character

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

Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either ‘v1’ or ‘disabled’

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

Include the stack trace of returned errors.

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

Whether to include a commentary on how the structure was derived

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

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

pub fn format(self, format: Format) -> Self

Optional parameter to specify the high level file format

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

Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file

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

Optional parameter to specify whether a delimited file includes the column names in its first row

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 line_merge_size_limit(self, line_merge_size_limit: i32) -> Self

Maximum number of characters permitted in a single message when lines are merged to create messages.

pub fn lines_to_sample(self, lines_to_sample: i32) -> Self

How many lines of the file should be included in the analysis

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

Pretty format the returned JSON response.

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

Optional parameter to specify the quote character for a delimited file - must be a single character

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 should_trim_fields(self, should_trim_fields: bool) -> Self

Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them

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

Timeout after which the analysis will be aborted

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

Optional parameter to specify the timestamp field in the file

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

Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format

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

Creates an asynchronous call to the Text Structure Find Structure API that can be awaited

Trait Implementations

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

fn clone(&self) -> TextStructureFindStructure<'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 TextStructureFindStructure<'a, 'b, B>

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

Formats the value using the given formatter.