Struct aws_sdk_iotevents::types::AnalysisResult
source · #[non_exhaustive]pub struct AnalysisResult {
pub type: Option<String>,
pub level: Option<AnalysisResultLevel>,
pub message: Option<String>,
pub locations: Option<Vec<AnalysisResultLocation>>,
}
Expand description
Contains the result of the analysis.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.type: Option<String>
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
-
supported-actions
- You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. -
service-limits
- Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase. -
structure
- The detector model must follow a structure that AWS IoT Events supports. -
expression-syntax
- Your expression must follow the required syntax. -
data-type
- Data types referenced in the detector model must be compatible. -
referenced-data
- You must define the data referenced in your detector model before you can use the data. -
referenced-resource
- Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
level: Option<AnalysisResultLevel>
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
-
INFO
- An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action. -
WARNING
- A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected. -
ERROR
- An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
message: Option<String>
Contains additional information about the analysis result.
locations: Option<Vec<AnalysisResultLocation>>
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
Implementations§
source§impl AnalysisResult
impl AnalysisResult
sourcepub fn type(&self) -> Option<&str>
pub fn type(&self) -> Option<&str>
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
-
supported-actions
- You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. -
service-limits
- Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase. -
structure
- The detector model must follow a structure that AWS IoT Events supports. -
expression-syntax
- Your expression must follow the required syntax. -
data-type
- Data types referenced in the detector model must be compatible. -
referenced-data
- You must define the data referenced in your detector model before you can use the data. -
referenced-resource
- Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
sourcepub fn level(&self) -> Option<&AnalysisResultLevel>
pub fn level(&self) -> Option<&AnalysisResultLevel>
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
-
INFO
- An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action. -
WARNING
- A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected. -
ERROR
- An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
sourcepub fn message(&self) -> Option<&str>
pub fn message(&self) -> Option<&str>
Contains additional information about the analysis result.
sourcepub fn locations(&self) -> &[AnalysisResultLocation]
pub fn locations(&self) -> &[AnalysisResultLocation]
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .locations.is_none()
.
source§impl AnalysisResult
impl AnalysisResult
sourcepub fn builder() -> AnalysisResultBuilder
pub fn builder() -> AnalysisResultBuilder
Creates a new builder-style object to manufacture AnalysisResult
.
Trait Implementations§
source§impl Clone for AnalysisResult
impl Clone for AnalysisResult
source§fn clone(&self) -> AnalysisResult
fn clone(&self) -> AnalysisResult
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AnalysisResult
impl Debug for AnalysisResult
source§impl PartialEq for AnalysisResult
impl PartialEq for AnalysisResult
source§fn eq(&self, other: &AnalysisResult) -> bool
fn eq(&self, other: &AnalysisResult) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AnalysisResult
Auto Trait Implementations§
impl Freeze for AnalysisResult
impl RefUnwindSafe for AnalysisResult
impl Send for AnalysisResult
impl Sync for AnalysisResult
impl Unpin for AnalysisResult
impl UnwindSafe for AnalysisResult
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> 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 more