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

Interface GetLabelDetectionRequest.Builder

    • Method Detail

      • jobId

        GetLabelDetectionRequest.Builder jobId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        GetLabelDetectionRequest.Builder maxResults​(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.

        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

        GetLabelDetectionRequest.Builder nextToken​(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.

        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

        GetLabelDetectionRequest.Builder sortBy​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LabelDetectionSortBy, LabelDetectionSortBy

      • sortBy

        GetLabelDetectionRequest.Builder sortBy​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LabelDetectionSortBy, LabelDetectionSortBy

      • aggregateBy

        GetLabelDetectionRequest.Builder aggregateBy​(String 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:
        LabelDetectionAggregateBy, LabelDetectionAggregateBy