Class DescribeLabelResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse
software.amazon.awssdk.services.lookoutequipment.model.DescribeLabelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeLabelResponse.Builder,DescribeLabelResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeLabelResponse extends LookoutEquipmentResponse implements ToCopyableBuilder<DescribeLabelResponse.Builder,DescribeLabelResponse>

  • Method Details

    • labelGroupName

      public final String labelGroupName()

      The name of the requested label group.

      Returns:
      The name of the requested label group.

    • labelGroupArn

      public final String labelGroupArn()

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

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

    • labelId

      public final String labelId()

      The ID of the requested label.

      Returns:
      The ID of the requested label.

    • startTime

      public final Instant startTime()

      The start time of the requested label.

      Returns:
      The start time of the requested label.

    • endTime

      public final Instant endTime()

      The end time of the requested label.

      Returns:
      The end time of the requested 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.

    • notes

      public final String notes()

      Metadata providing additional information about the label.

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

      Returns:
      Metadata providing additional information about 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 DescribeLabelResponse.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<DescribeLabelResponse.Builder,DescribeLabelResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeLabelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeLabelResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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