@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DetectLabelsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DetectLabelsRequest() |
Modifier and Type | Method and Description |
---|---|
DetectLabelsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getFeatures()
A list of the types of analysis to perform.
|
Image |
getImage()
The input image as base64-encoded bytes or an S3 object.
|
Integer |
getMaxLabels()
Maximum number of labels you want the service to return in the response.
|
Float |
getMinConfidence()
Specifies the minimum confidence level for the labels to return.
|
DetectLabelsSettings |
getSettings()
A list of the filters to be applied to returned detected labels and image properties.
|
int |
hashCode() |
void |
setFeatures(Collection<String> features)
A list of the types of analysis to perform.
|
void |
setImage(Image image)
The input image as base64-encoded bytes or an S3 object.
|
void |
setMaxLabels(Integer maxLabels)
Maximum number of labels you want the service to return in the response.
|
void |
setMinConfidence(Float minConfidence)
Specifies the minimum confidence level for the labels to return.
|
void |
setSettings(DetectLabelsSettings settings)
A list of the filters to be applied to returned detected labels and image properties.
|
String |
toString()
Returns a string representation of this object.
|
DetectLabelsRequest |
withFeatures(Collection<String> features)
A list of the types of analysis to perform.
|
DetectLabelsRequest |
withFeatures(DetectLabelsFeatureName... features)
A list of the types of analysis to perform.
|
DetectLabelsRequest |
withFeatures(String... features)
A list of the types of analysis to perform.
|
DetectLabelsRequest |
withImage(Image image)
The input image as base64-encoded bytes or an S3 object.
|
DetectLabelsRequest |
withMaxLabels(Integer maxLabels)
Maximum number of labels you want the service to return in the response.
|
DetectLabelsRequest |
withMinConfidence(Float minConfidence)
Specifies the minimum confidence level for the labels to return.
|
DetectLabelsRequest |
withSettings(DetectLabelsSettings settings)
A list of the filters to be applied to returned detected labels and image properties.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setImage(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.
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.
public Image getImage()
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.
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.
public DetectLabelsRequest withImage(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.
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.
public void setMaxLabels(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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.
maxLabels
- Maximum number of labels you want the service to return in the response. The service returns the specified
number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the
Feature input parameter.public Integer getMaxLabels()
Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.
public DetectLabelsRequest withMaxLabels(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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.
maxLabels
- Maximum number of labels you want the service to return in the response. The service returns the specified
number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the
Feature input parameter.public void setMinConfidence(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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input
parameter.
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. Only valid when GENERAL_LABELS is specified as a feature type in the
Feature input parameter.
public Float getMinConfidence()
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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input
parameter.
If MinConfidence
is not specified, the operation returns labels with a confidence values
greater than or equal to 55 percent. Only valid when GENERAL_LABELS is specified as a feature type in the
Feature input parameter.
public DetectLabelsRequest withMinConfidence(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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input
parameter.
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. Only valid when GENERAL_LABELS is specified as a feature type in the
Feature input parameter.
public List<String> getFeatures()
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
DetectLabelsFeatureName
public void setFeatures(Collection<String> features)
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
features
- A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature,
while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is
specified GENERAL_LABELS is used by default.DetectLabelsFeatureName
public DetectLabelsRequest withFeatures(String... features)
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
NOTE: This method appends the values to the existing list (if any). Use
setFeatures(java.util.Collection)
or withFeatures(java.util.Collection)
if you want to override
the existing values.
features
- A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature,
while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is
specified GENERAL_LABELS is used by default.DetectLabelsFeatureName
public DetectLabelsRequest withFeatures(Collection<String> features)
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
features
- A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature,
while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is
specified GENERAL_LABELS is used by default.DetectLabelsFeatureName
public DetectLabelsRequest withFeatures(DetectLabelsFeatureName... features)
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
features
- A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature,
while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is
specified GENERAL_LABELS is used by default.DetectLabelsFeatureName
public void setSettings(DetectLabelsSettings settings)
A list of the filters to be applied to returned detected labels and image properties. Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label categories. The exact label names or label categories must be supplied. For a full list of labels and label categories, see Detecting labels.
settings
- A list of the filters to be applied to returned detected labels and image properties. Specified filters
can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label
categories. The exact label names or label categories must be supplied. For a full list of labels and
label categories, see Detecting
labels.public DetectLabelsSettings getSettings()
A list of the filters to be applied to returned detected labels and image properties. Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label categories. The exact label names or label categories must be supplied. For a full list of labels and label categories, see Detecting labels.
public DetectLabelsRequest withSettings(DetectLabelsSettings settings)
A list of the filters to be applied to returned detected labels and image properties. Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label categories. The exact label names or label categories must be supplied. For a full list of labels and label categories, see Detecting labels.
settings
- A list of the filters to be applied to returned detected labels and image properties. Specified filters
can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label
categories. The exact label names or label categories must be supplied. For a full list of labels and
label categories, see Detecting
labels.public String toString()
toString
in class Object
Object.toString()
public DetectLabelsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()