Struct aws_sdk_internetmonitor::operation::start_query::builders::StartQueryInputBuilder

#[non_exhaustive]
pub struct StartQueryInputBuilder { /* private fields */ }

A builder for StartQueryInput.

Implementations

impl StartQueryInputBuilder

pub fn monitor_name(self, input: impl Into<String>) -> Self

The name of the monitor to query.

This field is required.

pub fn set_monitor_name(self, input: Option<String>) -> Self

The name of the monitor to query.

pub fn get_monitor_name(&self) -> &Option<String>

The name of the monitor to query.

pub fn start_time(self, input: DateTime) -> Self

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

This field is required.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

pub fn get_start_time(&self) -> &Option<DateTime>

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

pub fn end_time(self, input: DateTime) -> Self

The timestamp that is the end of the period that you want to retrieve data for with your query.

This field is required.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The timestamp that is the end of the period that you want to retrieve data for with your query.

pub fn get_end_time(&self) -> &Option<DateTime>

The timestamp that is the end of the period that you want to retrieve data for with your query.

pub fn query_type(self, input: QueryType) -> Self

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

• MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

• TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

• TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

This field is required.

pub fn set_query_type(self, input: Option<QueryType>) -> Self

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

• MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

• TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

• TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn get_query_type(&self) -> &Option<QueryType>

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

• MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

• TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

• TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn filter_parameters(self, input: FilterParameter) -> Self

Appends an item to filter_parameters.

To override the contents of this collection use set_filter_parameters.

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn set_filter_parameters(self, input: Option<Vec<FilterParameter>>) -> Self

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn get_filter_parameters(&self) -> &Option<Vec<FilterParameter>>

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn build(self) -> Result<StartQueryInput, BuildError>

Consumes the builder and constructs a StartQueryInput.

impl StartQueryInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartQueryOutput, SdkError<StartQueryError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartQueryInputBuilder

fn clone(&self) -> StartQueryInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryInputBuilder

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

Formats the value using the given formatter.

impl Default for StartQueryInputBuilder

fn default() -> StartQueryInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartQueryInputBuilder

fn eq(&self, other: &StartQueryInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartQueryInputBuilder