Package software.amazon.awssdk.services.lookoutequipment.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeLabelResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeLabelResponse.Builder	builder()
Instant	createdAt()	The time at which the label was created.
Instant	endTime()	The end time of the requested label.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	equipment()	Indicates that a label pertains to a particular piece of equipment.
String	faultCode()	Indicates the type of anomaly associated with the label.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	labelGroupArn()	The Amazon Resource Name (ARN) of the requested label group.
String	labelGroupName()	The name of the requested label group.
String	labelId()	The ID of the requested label.
String	notes()	Metadata providing additional information about the label.
LabelRating	rating()	Indicates whether a labeled event represents an anomaly.
String	ratingAsString()	Indicates whether a labeled event represents an anomaly.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLabelResponse.Builder>	serializableBuilderClass()
Instant	startTime()	The start time of the requested label.
DescribeLabelResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

LabelRating

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:

LabelRating

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLabelResponse.Builder,DescribeLabelResponse>

Specified by:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo