AnalysisResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotevents.model.AnalysisResult

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalysisResult
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains the result of the analysis.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalysisResult()

Constructors
Constructor and Description
`AnalysisResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalysisResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLevel()` The severity level of the analysis result.
`List<AnalysisResultLocation>`	`getLocations()` Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
`String`	`getMessage()` Contains additional information about the analysis result.
`String`	`getType()` The type of the analysis result.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLevel(String level)` The severity level of the analysis result.
`void`	`setLocations(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.
`void`	`setMessage(String message)` Contains additional information about the analysis result.
`void`	`setType(String type)` The type of the analysis result.
`String`	`toString()` Returns a string representation of this object.
`AnalysisResult`	`withLevel(AnalysisResultLevel level)` The severity level of the analysis result.
`AnalysisResult`	`withLevel(String level)` The severity level of the analysis result.
`AnalysisResult`	`withLocations(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`	`withLocations(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`	`withMessage(String message)` Contains additional information about the analysis result.
`AnalysisResult`	`withType(String type)` The type of the analysis result.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalysisResult
```
public AnalysisResult()
```
- Method Detail
  - setType
```
public void setType(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.
  - getType
```
public String getType()
```
    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.
  - withType
```
public AnalysisResult withType(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.
  - setLevel
```
public void setLevel(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.
    See Also:
    
    AnalysisResultLevel
  - getLevel
```
public String getLevel()
```
    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:
    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
  - withLevel
```
public AnalysisResult withLevel(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
  - withLevel
```
public AnalysisResult withLevel(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
  - setMessage
```
public void setMessage(String message)
```
    Contains additional information about the analysis result.
    
    Parameters:
    
    message - Contains additional information about the analysis result.
  - getMessage
```
public String getMessage()
```
    Contains additional information about the analysis result.
    
    Returns:
    
    Contains additional information about the analysis result.
  - withMessage
```
public AnalysisResult withMessage(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.
  - getLocations
```
public List<AnalysisResultLocation> getLocations()
```
    Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
    
    Returns:
    
    Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
  - setLocations
```
public void setLocations(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.
  - withLocations
```
public AnalysisResult withLocations(AnalysisResultLocation... locations)
```
    Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
    
    NOTE: This method appends the values to the existing list (if any). Use setLocations(java.util.Collection) or withLocations(java.util.Collection) if you want to override the existing values.
    
    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.
  - withLocations
```
public AnalysisResult withLocations(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AnalysisResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.545

Class AnalysisResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalysisResult

Method Detail

setType

getType

withType

setLevel

getLevel

withLevel

withLevel

setMessage

getMessage

withMessage

getLocations

setLocations

withLocations

withLocations

toString

equals

hashCode

clone

marshall