Package software.amazon.awssdk.services.rekognition.model

Interface DetectLabelsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DetectLabelsRequest.Builder,DetectLabelsRequest>, RekognitionRequest.Builder, SdkBuilder<DetectLabelsRequest.Builder,DetectLabelsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DetectLabelsRequest
public static interface DetectLabelsRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<DetectLabelsRequest.Builder,DetectLabelsRequest>

  • Method Details

    • image

      DetectLabelsRequest.Builder image(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • image

      default DetectLabelsRequest.Builder image(Consumer<Image.Builder> 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.

      This is a convenience method that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to image(Image).

      Parameters:
      image - a consumer that will call methods on Image.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxLabels

      DetectLabelsRequest.Builder maxLabels(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minConfidence

      DetectLabelsRequest.Builder minConfidence(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featuresWithStrings

      DetectLabelsRequest.Builder featuresWithStrings(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featuresWithStrings

      DetectLabelsRequest.Builder featuresWithStrings(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • features

      DetectLabelsRequest.Builder features(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • features

      DetectLabelsRequest.Builder features(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      DetectLabelsRequest.Builder settings(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      default DetectLabelsRequest.Builder settings(Consumer<DetectLabelsSettings.Builder> 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.

      This is a convenience method that creates an instance of the DetectLabelsSettings.Builder avoiding the need to create one manually via DetectLabelsSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(DetectLabelsSettings).

      Parameters:
      settings - a consumer that will call methods on DetectLabelsSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DetectLabelsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DetectLabelsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.