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

Interface AnalysisResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AnalysisResult.Builder,AnalysisResult>, SdkBuilder<AnalysisResult.Builder,AnalysisResult>, SdkPojo

Enclosing class:

AnalysisResult

public static interface AnalysisResult.Builder
extends SdkPojo, CopyableBuilder<AnalysisResult.Builder,AnalysisResult>

Method Summary

Modifier and Type	Method	Description
AnalysisResult.Builder	level(String level)	The severity level of the analysis result.
AnalysisResult.Builder	level(AnalysisResultLevel level)	The severity level of the analysis result.
AnalysisResult.Builder	locations(Collection<AnalysisResultLocation> locations)	Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
AnalysisResult.Builder	locations(Consumer<AnalysisResultLocation.Builder>... locations)	Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
AnalysisResult.Builder	locations(AnalysisResultLocation... locations)	Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
AnalysisResult.Builder	message(String message)	Contains additional information about the analysis result.
AnalysisResult.Builder	type(String type)	The type of the analysis result.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

type

AnalysisResult.Builder type(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

level

AnalysisResult.Builder level(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalysisResultLevel, AnalysisResultLevel

level

AnalysisResult.Builder level(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalysisResultLevel, AnalysisResultLevel

message

AnalysisResult.Builder message(String message)

Contains additional information about the analysis result.

Parameters:

message - Contains additional information about the analysis result.

Returns:

Returns a reference to this object so that method calls can be chained together.

locations

AnalysisResult.Builder locations(Collection<AnalysisResultLocation> locations)

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

Parameters:

locations - Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

Returns:

Returns a reference to this object so that method calls can be chained together.

locations

AnalysisResult.Builder locations(AnalysisResultLocation... locations)

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

Parameters:

locations - Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

Returns:

Returns a reference to this object so that method calls can be chained together.

locations

AnalysisResult.Builder locations(Consumer<AnalysisResultLocation.Builder>... locations)

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

This is a convenience method that creates an instance of the AnalysisResultLocation.Builder avoiding the need to create one manually via AnalysisResultLocation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #locations(List).

Parameters:

locations - a consumer that will call methods on AnalysisResultLocation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#locations(java.util.Collection)