software.amazon.awssdk.services.rekognition.model

Class DetectLabelsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.DetectLabelsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectLabelsRequest.Builder,DetectLabelsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectLabelsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DetectLabelsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Image	image() The input image as base64-encoded bytes or an S3 object.
Integer	maxLabels() Maximum number of labels you want the service to return in the response.
Float	minConfidence() Specifies the minimum confidence level for the labels to return.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectLabelsRequest.Builder>	serializableBuilderClass()
DetectLabelsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

image

public Image image()

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

maxLabels

public Integer maxLabels()

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Returns:

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

minConfidence

public Float minConfidence()

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Returns:

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

toBuilder

public DetectLabelsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectLabelsRequest.Builder,DetectLabelsRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static DetectLabelsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DetectLabelsRequest.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()

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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo