Interface GetDocumentInsightsResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<GetDocumentInsightsResponse.Builder,,GetDocumentInsightsResponse> SdkBuilder<GetDocumentInsightsResponse.Builder,,GetDocumentInsightsResponse> SdkPojo,SdkResponse.Builder,TextractResponse.Builder
- Enclosing class:
GetDocumentInsightsResponse
-
Method Summary
Modifier and TypeMethodDescriptionerrorMessage(String errorMessage) A human-readable description of the error that caused the job to fail.The type of error that caused the job to fail.outputConfiguration(Consumer<OutputConfiguration.Builder> outputConfiguration) The Amazon S3 location where the analysis results are written.outputConfiguration(OutputConfiguration outputConfiguration) The Amazon S3 location where the analysis results are written.The current status of the document insights job, indicating whether it is still running, has completed, or has failed.The current status of the document insights job, indicating whether it is still running, has completed, or has failed.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponseMethods inherited from interface software.amazon.awssdk.services.textract.model.TextractResponse.Builder
build, responseMetadata, responseMetadata
-
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
ErrorTypeandErrorMessagefor 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, inspectErrorTypeandErrorMessagefor 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
ErrorTypeandErrorMessagefor 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, inspectErrorTypeandErrorMessagefor details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOutputConfiguration.Builderavoiding the need to create one manually viaOutputConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputConfiguration(OutputConfiguration).- Parameters:
outputConfiguration- a consumer that will call methods onOutputConfiguration.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
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.
-