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

Class ListDatasetEntriesRequest

    • Method Detail

      • datasetArn

        public final String datasetArn()

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

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

      • hasContainsLabels

        public final boolean hasContainsLabels()
        For responses, this returns true if the service returned a value for the ContainsLabels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • containsLabels

        public final List<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.

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

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainsLabels() method.

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

      • labeled

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

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

      • sourceRefContains

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

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

      • hasErrors

        public final Boolean hasErrors()

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

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

      • nextToken

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

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

      • maxResults

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

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

      • toString

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