Interface ListDatasetEntriesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListDatasetEntriesRequest.Builder,
,ListDatasetEntriesRequest> RekognitionRequest.Builder
,SdkBuilder<ListDatasetEntriesRequest.Builder,
,ListDatasetEntriesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListDatasetEntriesRequest
-
Method Summary
Modifier and TypeMethodDescriptioncontainsLabels
(String... containsLabels) Specifies a label filter for the response.containsLabels
(Collection<String> containsLabels) Specifies a label filter for the response.datasetArn
(String datasetArn) The Amazon Resource Name (ARN) for the dataset that you want to use.Specifies an error filter for the response.Specifytrue
to get only the JSON Lines where the image is labeled.maxResults
(Integer maxResults) The maximum number of results to return per paginated call.If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sourceRefContains
(String sourceRefContains) If specified,ListDatasetEntries
only returns JSON Lines where the value ofSourceRefContains
is part of thesource-ref
field.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 inContainsLabels
exist in the entry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 inContainsLabels
exist in the entry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labeled
Specify
true
to get only the JSON Lines where the image is labeled. Specifyfalse
to get only the JSON Lines where the image isn't labeled. If you don't specifyLabeled
,ListDatasetEntries
returns JSON Lines for labeled and unlabeled images.- Parameters:
labeled
- Specifytrue
to get only the JSON Lines where the image is labeled. Specifyfalse
to get only the JSON Lines where the image isn't labeled. If you don't specifyLabeled
,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
If specified,
ListDatasetEntries
only returns JSON Lines where the value ofSourceRefContains
is part of thesource-ref
field. Thesource-ref
field contains the Amazon S3 location of the image. You can useSouceRefContains
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 ofSourceRefContains
is part of thesource-ref
field. Thesource-ref
field contains the Amazon S3 location of the image. You can useSouceRefContains
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
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. SpecifyTrue
to only include entries that have errors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-