Class AnalysisResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AnalysisResult.Builder,
AnalysisResult>
Contains the result of the analysis.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AnalysisResult.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Locations property.final AnalysisResultLevel
level()
The severity level of the analysis result.final String
The severity level of the analysis result.final List
<AnalysisResultLocation> Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.final String
message()
Contains additional information about the analysis result.static Class
<? extends AnalysisResult.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The type of the analysis result.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
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.
- Returns:
- 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
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.
If the service returns an enum value that is not available in the current SDK version,
level
will returnAnalysisResultLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
levelAsString
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.
If the service returns an enum value that is not available in the current SDK version,
level
will returnAnalysisResultLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
message
Contains additional information about the analysis result.
- Returns:
- Contains additional information about the analysis result.
-
hasLocations
public final boolean hasLocations()For responses, this returns true if the service returned a value for the Locations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
locations
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLocations()
method.- Returns:
- Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AnalysisResult.Builder,
AnalysisResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-