Interface GetDocumentInsightsResponse.Builder

  • Method Details

    • status

      The current status of the document insights job, indicating whether it is still running, has completed, or has failed. When the job has failed, inspect ErrorType and ErrorMessage for details.

      Parameters:
      status - The current status of the document insights job, indicating whether it is still running, has completed, or has failed. When the job has failed, inspect ErrorType and ErrorMessage for details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The current status of the document insights job, indicating whether it is still running, has completed, or has failed. When the job has failed, inspect ErrorType and ErrorMessage for details.

      Parameters:
      status - The current status of the document insights job, indicating whether it is still running, has completed, or has failed. When the job has failed, inspect ErrorType and ErrorMessage for details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • outputConfiguration

      GetDocumentInsightsResponse.Builder outputConfiguration(OutputConfiguration outputConfiguration)

      The Amazon S3 location where the analysis results are written.

      Parameters:
      outputConfiguration - The Amazon S3 location where the analysis results are written.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputConfiguration

      default GetDocumentInsightsResponse.Builder outputConfiguration(Consumer<OutputConfiguration.Builder> outputConfiguration)

      The Amazon S3 location where the analysis results are written.

      This is a convenience method that creates an instance of the OutputConfiguration.Builder avoiding the need to create one manually via OutputConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfiguration(OutputConfiguration).

      Parameters:
      outputConfiguration - a consumer that will call methods on OutputConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • errorType

      The type of error that caused the job to fail. Present only when the job status is a failure state.

      Parameters:
      errorType - The type of error that caused the job to fail. Present only when the job status is a failure state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorMessage

      GetDocumentInsightsResponse.Builder errorMessage(String errorMessage)

      A human-readable description of the error that caused the job to fail. Present only when the job status is a failure state.

      Parameters:
      errorMessage - A human-readable description of the error that caused the job to fail. Present only when the job status is a failure state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.