Class Insight

java.lang.Object
software.amazon.awssdk.services.opensearch.model.Insight
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Insight.Builder,Insight>
@Generated("software.amazon.awssdk:codegen") public final class Insight extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Insight.Builder,Insight>

Represents an insight returned by the ListInsights operation. An insight is a notification about a domain event or recommendation that helps you optimize your Amazon OpenSearch Service domain.

See Also:

  • Method Details

    • insightId

      public final String insightId()

      The unique identifier of the insight.

      Returns:
      The unique identifier of the insight.

    • displayName

      public final String displayName()

      The display name of the insight.

      Returns:
      The display name of the insight.

    • type

      public final InsightType type()

      The type of the insight. Possible values are EVENT and RECOMMENDATION.

      If the service returns an enum value that is not available in the current SDK version, type will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the insight. Possible values are EVENT and RECOMMENDATION.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the insight. Possible values are EVENT and RECOMMENDATION.

      If the service returns an enum value that is not available in the current SDK version, type will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the insight. Possible values are EVENT and RECOMMENDATION.
      See Also:

    • priority

      public final InsightPriorityLevel priority()

      The priority level of the insight. Possible values are CRITICAL, HIGH, MEDIUM, and LOW.

      If the service returns an enum value that is not available in the current SDK version, priority will return InsightPriorityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The priority level of the insight. Possible values are CRITICAL, HIGH, MEDIUM, and LOW.
      See Also:

    • priorityAsString

      public final String priorityAsString()

      The priority level of the insight. Possible values are CRITICAL, HIGH, MEDIUM, and LOW.

      If the service returns an enum value that is not available in the current SDK version, priority will return InsightPriorityLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The priority level of the insight. Possible values are CRITICAL, HIGH, MEDIUM, and LOW.
      See Also:

    • status

      public final InsightStatus status()

      The current status of the insight. Possible values are ACTIVE, RESOLVED, and DISMISSED.

      If the service returns an enum value that is not available in the current SDK version, status will return InsightStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the insight. Possible values are ACTIVE, RESOLVED, and DISMISSED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the insight. Possible values are ACTIVE, RESOLVED, and DISMISSED.

      If the service returns an enum value that is not available in the current SDK version, status will return InsightStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the insight. Possible values are ACTIVE, RESOLVED, and DISMISSED.
      See Also:

    • creationTime

      public final Instant creationTime()

      The timestamp when the insight was created, in epoch milliseconds.

      Returns:
      The timestamp when the insight was created, in epoch milliseconds.

    • updateTime

      public final Instant updateTime()

      The timestamp when the insight was last updated, in epoch milliseconds.

      Returns:
      The timestamp when the insight was last updated, in epoch milliseconds.

    • isExperimental

      public final Boolean isExperimental()

      Indicates whether the insight is experimental.

      Returns:
      Indicates whether the insight is experimental.

    • toBuilder

      public Insight.Builder 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 interface ToCopyableBuilder<Insight.Builder,Insight>
      Returns:
      a builder for type T

    • builder

      public static Insight.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Insight.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.