pub struct DescribeQueryFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to DescribeQuery.
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specified RefreshId.
Implementations§
Source§impl DescribeQueryFluentBuilder
impl DescribeQueryFluentBuilder
Sourcepub fn as_input(&self) -> &DescribeQueryInputBuilder
pub fn as_input(&self) -> &DescribeQueryInputBuilder
Access the DescribeQuery as a reference.
Sourcepub async fn send(
self,
) -> Result<DescribeQueryOutput, SdkError<DescribeQueryError, HttpResponse>>
pub async fn send( self, ) -> Result<DescribeQueryOutput, SdkError<DescribeQueryError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<DescribeQueryOutput, DescribeQueryError, Self>
pub fn customize( self, ) -> CustomizableOperation<DescribeQueryOutput, DescribeQueryError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn event_data_store(self, input: impl Into<String>) -> Self
👎Deprecated: EventDataStore is no longer required by DescribeQueryRequest
pub fn event_data_store(self, input: impl Into<String>) -> Self
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
Sourcepub fn set_event_data_store(self, input: Option<String>) -> Self
👎Deprecated: EventDataStore is no longer required by DescribeQueryRequest
pub fn set_event_data_store(self, input: Option<String>) -> Self
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
Sourcepub fn get_event_data_store(&self) -> &Option<String>
👎Deprecated: EventDataStore is no longer required by DescribeQueryRequest
pub fn get_event_data_store(&self) -> &Option<String>
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
Sourcepub fn set_query_id(self, input: Option<String>) -> Self
pub fn set_query_id(self, input: Option<String>) -> Self
The query ID.
Sourcepub fn get_query_id(&self) -> &Option<String>
pub fn get_query_id(&self) -> &Option<String>
The query ID.
Sourcepub fn query_alias(self, input: impl Into<String>) -> Self
pub fn query_alias(self, input: impl Into<String>) -> Self
The alias that identifies a query template.
Sourcepub fn set_query_alias(self, input: Option<String>) -> Self
pub fn set_query_alias(self, input: Option<String>) -> Self
The alias that identifies a query template.
Sourcepub fn get_query_alias(&self) -> &Option<String>
pub fn get_query_alias(&self) -> &Option<String>
The alias that identifies a query template.
Sourcepub fn refresh_id(self, input: impl Into<String>) -> Self
pub fn refresh_id(self, input: impl Into<String>) -> Self
The ID of the dashboard refresh.
Sourcepub fn set_refresh_id(self, input: Option<String>) -> Self
pub fn set_refresh_id(self, input: Option<String>) -> Self
The ID of the dashboard refresh.
Sourcepub fn get_refresh_id(&self) -> &Option<String>
pub fn get_refresh_id(&self) -> &Option<String>
The ID of the dashboard refresh.
Sourcepub fn event_data_store_owner_account_id(self, input: impl Into<String>) -> Self
pub fn event_data_store_owner_account_id(self, input: impl Into<String>) -> Self
The account ID of the event data store owner.
Sourcepub fn set_event_data_store_owner_account_id(
self,
input: Option<String>,
) -> Self
pub fn set_event_data_store_owner_account_id( self, input: Option<String>, ) -> Self
The account ID of the event data store owner.
Sourcepub fn get_event_data_store_owner_account_id(&self) -> &Option<String>
pub fn get_event_data_store_owner_account_id(&self) -> &Option<String>
The account ID of the event data store owner.
Trait Implementations§
Source§impl Clone for DescribeQueryFluentBuilder
impl Clone for DescribeQueryFluentBuilder
Source§fn clone(&self) -> DescribeQueryFluentBuilder
fn clone(&self) -> DescribeQueryFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for DescribeQueryFluentBuilder
impl !RefUnwindSafe for DescribeQueryFluentBuilder
impl Send for DescribeQueryFluentBuilder
impl Sync for DescribeQueryFluentBuilder
impl Unpin for DescribeQueryFluentBuilder
impl !UnwindSafe for DescribeQueryFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);