software.amazon.awssdk.services.rekognition.model

Class DetectLabelsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.DetectLabelsResponse

All Implemented Interfaces:

ToCopyableBuilder<DetectLabelsResponse.Builder,DetectLabelsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DetectLabelsResponse
extends RekognitionResponse
implements ToCopyableBuilder<DetectLabelsResponse.Builder,DetectLabelsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectLabelsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DetectLabelsResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<Label>	labels() An array of labels for the real-world objects detected.
OrientationCorrection	orientationCorrection() The orientation of the input image (counter-clockwise direction).
String	orientationCorrectionAsString() The orientation of the input image (counter-clockwise direction).
static Class<? extends DetectLabelsResponse.Builder>	serializableBuilderClass()
DetectLabelsResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

labels

public List<Label> labels()

An array of labels for the real-world objects detected.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of labels for the real-world objects detected.

orientationCorrection

public OrientationCorrection orientationCorrection()

The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.

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

Returns:

The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.

See Also:

OrientationCorrection

orientationCorrectionAsString

public String orientationCorrectionAsString()

The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.

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

Returns:

The orientation of the input image (counter-clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

If the input image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be null.

See Also:

OrientationCorrection

toBuilder

public DetectLabelsResponse.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<DetectLabelsResponse.Builder,DetectLabelsResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DetectLabelsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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