Class GetLabelDetectionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetLabelDetectionRequest.Builder,
GetLabelDetectionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionDefines how to aggregate the returned results.final String
Defines how to aggregate the returned results.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
jobId()
Job identifier for the label detection operation for which you want results returned.final Integer
Maximum number of results to return per paginated call.final String
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.static Class
<? extends GetLabelDetectionRequest.Builder> final LabelDetectionSortBy
sortBy()
Sort to use for elements in theLabels
array.final String
Sort to use for elements in theLabels
array.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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
.- Returns:
- Job identifier for the label detection operation for which you want results returned. You get the job
identifer from an initial call to
StartlabelDetection
.
-
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:
- 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.
-
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:
- 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.
-
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
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnLabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- 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
. - See Also:
-
sortByAsString
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
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnLabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- 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
. - See Also:
-
aggregateBy
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
If the service returns an enum value that is not available in the current SDK version,
aggregateBy
will returnLabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaggregateByAsString()
.- Returns:
- Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
- See Also:
-
aggregateByAsString
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
If the service returns an enum value that is not available in the current SDK version,
aggregateBy
will returnLabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaggregateByAsString()
.- Returns:
- Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetLabelDetectionRequest.Builder,
GetLabelDetectionRequest> - Specified by:
toBuilder
in classRekognitionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-