Interface GetLabelDetectionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetLabelDetectionRequest.Builder,
,GetLabelDetectionRequest> RekognitionRequest.Builder
,SdkBuilder<GetLabelDetectionRequest.Builder,
,GetLabelDetectionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetLabelDetectionRequest
-
Method Summary
Modifier and TypeMethodDescriptionaggregateBy
(String aggregateBy) Defines how to aggregate the returned results.aggregateBy
(LabelDetectionAggregateBy aggregateBy) Defines how to aggregate the returned results.Job identifier for the label detection operation for which you want results returned.maxResults
(Integer maxResults) Maximum number of results to return per paginated call.If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video 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.Sort to use for elements in theLabels
array.sortBy
(LabelDetectionSortBy sortBy) Sort to use for elements in theLabels
array.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
-
jobId
Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to
StartlabelDetection
.- Parameters:
jobId
- Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call toStartlabelDetection
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
- Parameters:
maxResults
- Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
- Parameters:
nextToken
- If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
Sort to use for elements in the
Labels
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.- Parameters:
sortBy
- Sort to use for elements in theLabels
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortBy
Sort to use for elements in the
Labels
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.- Parameters:
sortBy
- Sort to use for elements in theLabels
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
aggregateBy
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
- Parameters:
aggregateBy
- Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
aggregateBy
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
- Parameters:
aggregateBy
- Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetLabelDetectionRequest.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
GetLabelDetectionRequest.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.
-