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

Interface GetCelebrityRecognitionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetCelebrityRecognitionRequest.Builder,GetCelebrityRecognitionRequest>, RekognitionRequest.Builder, SdkBuilder<GetCelebrityRecognitionRequest.Builder,GetCelebrityRecognitionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetCelebrityRecognitionRequest
public static interface GetCelebrityRecognitionRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<GetCelebrityRecognitionRequest.Builder,GetCelebrityRecognitionRequest>

  • Method Details

    • jobId

      GetCelebrityRecognitionRequest.Builder jobId(String jobId)

      Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

      Parameters:
      jobId - Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetCelebrityRecognitionRequest.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

      GetCelebrityRecognitionRequest.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

      Parameters:
      nextToken - If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      GetCelebrityRecognitionRequest.Builder sortBy(String sortBy)

      Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

      Parameters:
      sortBy - Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      GetCelebrityRecognitionRequest.Builder sortBy(CelebrityRecognitionSortBy sortBy)

      Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

      Parameters:
      sortBy - Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GetCelebrityRecognitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetCelebrityRecognitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.