Class LabelSummary

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

Information about the label.

See Also:

  • Method Details

    • labelGroupName

      public final String labelGroupName()

      The name of the label group.

      Returns:
      The name of the label group.

    • labelId

      public final String labelId()

      The ID of the label.

      Returns:
      The ID of the label.

    • labelGroupArn

      public final String labelGroupArn()

      The Amazon Resource Name (ARN) of the label group.

      Returns:
      The Amazon Resource Name (ARN) of the label group.

    • startTime

      public final Instant startTime()

      The timestamp indicating the start of the label.

      Returns:
      The timestamp indicating the start of the label.

    • endTime

      public final Instant endTime()

      The timestamp indicating the end of the label.

      Returns:
      The timestamp indicating the end of the label.

    • rating

      public final LabelRating rating()

      Indicates whether a labeled event represents an anomaly.

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

      Returns:
      Indicates whether a labeled event represents an anomaly.
      See Also:

    • ratingAsString

      public final String ratingAsString()

      Indicates whether a labeled event represents an anomaly.

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

      Returns:
      Indicates whether a labeled event represents an anomaly.
      See Also:

    • faultCode

      public final String faultCode()

      Indicates the type of anomaly associated with the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

      Returns:
      Indicates the type of anomaly associated with the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • equipment

      public final String equipment()

      Indicates that a label pertains to a particular piece of equipment.

      Returns:
      Indicates that a label pertains to a particular piece of equipment.

    • createdAt

      public final Instant createdAt()

      The time at which the label was created.

      Returns:
      The time at which the label was created.

    • toBuilder

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

    • builder

      public static LabelSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LabelSummary.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.