Struct elasticsearch::text_structure::TextStructureFindStructure [−][src]
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.
Optional, experimental
This requires the experimental-apis
feature. Can have breaking changes in future
versions or might even be removed entirely.
Implementations
impl<'a, 'b, B> TextStructureFindStructure<'a, 'b, B> where
B: Body,
[src]
B: Body,
pub fn new(transport: &'a Transport) -> Self
[src]
Creates a new instance of TextStructureFindStructure
pub fn body<T>(
self,
body: Vec<T>
) -> TextStructureFindStructure<'a, 'b, NdBody<T>> where
T: Body,
[src]
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
[src]
Optional parameter to specify the character set of the file
pub fn column_names(self, column_names: &'b [&'b str]) -> Self
[src]
Optional parameter containing a comma separated list of the column names for a delimited file
pub fn delimiter(self, delimiter: &'b str) -> Self
[src]
Optional parameter to specify the delimiter character for a delimited file - must be a single character
pub fn error_trace(self, error_trace: bool) -> Self
[src]
Include the stack trace of returned errors.
pub fn explain(self, explain: bool) -> Self
[src]
Whether to include a commentary on how the structure was derived
pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
[src]
A comma-separated list of filters used to reduce the response.
pub fn format(self, format: Format) -> Self
[src]
Optional parameter to specify the high level file format
pub fn grok_pattern(self, grok_pattern: &'b str) -> Self
[src]
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
[src]
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
[src]
Adds a HTTP header
pub fn human(self, human: bool) -> Self
[src]
Return human readable values for statistics.
pub fn line_merge_size_limit(self, line_merge_size_limit: i32) -> Self
[src]
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
[src]
How many lines of the file should be included in the analysis
pub fn pretty(self, pretty: bool) -> Self
[src]
Pretty format the returned JSON response.
pub fn quote(self, quote: &'b str) -> Self
[src]
Optional parameter to specify the quote character for a delimited file - must be a single character
pub fn request_timeout(self, timeout: Duration) -> Self
[src]
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
[src]
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
[src]
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
[src]
Timeout after which the analysis will be aborted
pub fn timestamp_field(self, timestamp_field: &'b str) -> Self
[src]
Optional parameter to specify the timestamp field in the file
pub fn timestamp_format(self, timestamp_format: &'b str) -> Self
[src]
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>
[src]
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>
[src]
fn clone(&self) -> TextStructureFindStructure<'a, 'b, B>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, 'b, B: Debug> Debug for TextStructureFindStructure<'a, 'b, B>
[src]
Auto Trait Implementations
impl<'a, 'b, B> !RefUnwindSafe for TextStructureFindStructure<'a, 'b, B>
impl<'a, 'b, B> Send for TextStructureFindStructure<'a, 'b, B> where
B: Send,
B: Send,
impl<'a, 'b, B> Sync for TextStructureFindStructure<'a, 'b, B> where
B: Sync,
B: Sync,
impl<'a, 'b, B> Unpin for TextStructureFindStructure<'a, 'b, B> where
B: Unpin,
B: Unpin,
impl<'a, 'b, B> !UnwindSafe for TextStructureFindStructure<'a, 'b, B>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
pub fn __clone_box(&self, Private) -> *mut ()
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,