/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iotevents.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Contains the result of the analysis. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AnalysisResult implements Serializable, Cloneable, StructuredPojo { /** *

* 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. *

*/ private String type; /** *

* 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. *
*

*/ private String level; /** *

* Contains additional information about the analysis result. *

*/ private String message; /** *

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

*/ private java.util.List locations; /** *

* 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. *

* * @param 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. */ public void setType(String type) { this.type = 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. *

* * @return 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. */ public String getType() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public AnalysisResult withType(String type) { setType(type); return this; } /** *

* 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. *
*

* * @param 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* Contains additional information about the analysis result. *

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

getLocations() { return locations; } /** *

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

* * @param locations * Contains one or more locations that you can use to locate the fields in your detector model that the * analysis result references. */ public void setLocations(java.util.Collection locations) { if (locations == null) { this.locations = null; return; } this.locations = new java.util.ArrayList(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 * {@link #setLocations(java.util.Collection)} or {@link #withLocations(java.util.Collection)} if you want to * override the existing values. *

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

* * @param locations * Contains one or more locations that you can use to locate the fields in your detector model that the * analysis result references. * @return Returns a reference to this object so that method calls can be chained together. */ public AnalysisResult withLocations(java.util.Collection locations) { setLocations(locations); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getType() != null) sb.append("Type: ").append(getType()).append(","); if (getLevel() != null) sb.append("Level: ").append(getLevel()).append(","); if (getMessage() != null) sb.append("Message: ").append(getMessage()).append(","); if (getLocations() != null) sb.append("Locations: ").append(getLocations()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AnalysisResult == false) return false; AnalysisResult other = (AnalysisResult) obj; if (other.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getLevel() == null ^ this.getLevel() == null) return false; if (other.getLevel() != null && other.getLevel().equals(this.getLevel()) == false) return false; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false) return false; if (other.getLocations() == null ^ this.getLocations() == null) return false; if (other.getLocations() != null && other.getLocations().equals(this.getLocations()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getLevel() == null) ? 0 : getLevel().hashCode()); hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getLocations() == null) ? 0 : getLocations().hashCode()); return hashCode; } @Override public AnalysisResult clone() { try { return (AnalysisResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.iotevents.model.transform.AnalysisResultMarshaller.getInstance().marshall(this, protocolMarshaller); } }