Class GetLabelDetectionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rekognition.model.RekognitionRequest
software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetLabelDetectionRequest extends RekognitionRequest implements ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

  • Method Details

    • jobId

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

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

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

      public final LabelDetectionSortBy sortBy()

      Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.
      See Also:

    • aggregateBy

      public final LabelDetectionAggregateBy 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 return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

      Returns:
      Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
      See Also:

    • aggregateByAsString

      public final String 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 return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

      Returns:
      Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
      See Also:

    • toBuilder

      public GetLabelDetectionRequest.Builder 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 interface ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static GetLabelDetectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetLabelDetectionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.