Interface ListDatasetEntriesRequest.Builder

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

  • Method Details

    • datasetArn

      ListDatasetEntriesRequest.Builder datasetArn(String datasetArn)

      The Amazon Resource Name (ARN) for the dataset that you want to use.

      Parameters:
      datasetArn - The Amazon Resource Name (ARN) for the dataset that you want to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containsLabels

      ListDatasetEntriesRequest.Builder containsLabels(Collection<String> containsLabels)

      Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

      Parameters:
      containsLabels - Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containsLabels

      ListDatasetEntriesRequest.Builder containsLabels(String... containsLabels)

      Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

      Parameters:
      containsLabels - Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labeled

      ListDatasetEntriesRequest.Builder labeled(Boolean labeled)

      Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

      Parameters:
      labeled - Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceRefContains

      ListDatasetEntriesRequest.Builder sourceRefContains(String sourceRefContains)

      If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

      Parameters:
      sourceRefContains - If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hasErrors

      ListDatasetEntriesRequest.Builder hasErrors(Boolean hasErrors)

      Specifies an error filter for the response. Specify True to only include entries that have errors.

      Parameters:
      hasErrors - Specifies an error filter for the response. Specify True to only include entries that have errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListDatasetEntriesRequest.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

      Parameters:
      nextToken - If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListDatasetEntriesRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

      Parameters:
      maxResults - The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListDatasetEntriesRequest.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

      ListDatasetEntriesRequest.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.