Package software.amazon.awssdk.services.iotevents.model

Class AnalysisResult

java.lang.Object

software.amazon.awssdk.services.iotevents.model.AnalysisResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisResult.Builder,AnalysisResult>

@Generated("software.amazon.awssdk:codegen")
public final class AnalysisResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisResult.Builder,AnalysisResult>

Contains the result of the analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisResult.Builder

Method Summary

Modifier and Type	Method	Description
static AnalysisResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLocations()	For responses, this returns true if the service returned a value for the Locations property.
AnalysisResultLevel	level()	The severity level of the analysis result.
String	levelAsString()	The severity level of the analysis result.
List<AnalysisResultLocation>	locations()	Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
String	message()	Contains additional information about the analysis result.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisResult.Builder>	serializableBuilderClass()
AnalysisResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of the analysis result.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final String 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

public final AnalysisResultLevel 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 return AnalysisResultLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from levelAsString().

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:

AnalysisResultLevel

levelAsString

public final String 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 return AnalysisResultLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from levelAsString().

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:

AnalysisResultLevel

message

public final String 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 the isEmpty() 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

public final List<AnalysisResultLocation> 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

public AnalysisResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisResult.Builder,AnalysisResult>

builder

public static AnalysisResult.Builder builder()

serializableBuilderClass

public static Class<? extends AnalysisResult.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo