Interface StartDocumentInsightsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<StartDocumentInsightsRequest.Builder,,StartDocumentInsightsRequest> SdkBuilder<StartDocumentInsightsRequest.Builder,,StartDocumentInsightsRequest> SdkPojo,SdkRequest.Builder,TextractRequest.Builder
- Enclosing class:
StartDocumentInsightsRequest
-
Method Summary
Modifier and TypeMethodDescriptionblueprints(Collection<BlueprintItem> blueprints) The blueprints used to extract custom structured output from the document.blueprints(Consumer<BlueprintItem.Builder>... blueprints) The blueprints used to extract custom structured output from the document.blueprints(BlueprintItem... blueprints) The blueprints used to extract custom structured output from the document.encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) The AWS KMS encryption configuration used to encrypt the analysis output.encryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The AWS KMS encryption configuration used to encrypt the analysis output.inputConfiguration(Consumer<InputConfiguration.Builder> inputConfiguration) The Amazon S3 location of the input document to analyze.inputConfiguration(InputConfiguration inputConfiguration) The Amazon S3 location of the input document to analyze.notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Notification settings for the job.notificationConfiguration(NotificationConfiguration notificationConfiguration) Notification settings for the job.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.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.projectArn(String projectArn) The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.A set of tags (key-value pairs) to assign to the document insights job.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods 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.services.textract.model.TextractRequest.Builder
build
-
Method Details
-
inputConfiguration
The Amazon S3 location of the input document to analyze.
- Parameters:
inputConfiguration- The Amazon S3 location of the input document to analyze.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputConfiguration
default StartDocumentInsightsRequest.Builder inputConfiguration(Consumer<InputConfiguration.Builder> inputConfiguration) The Amazon S3 location of the input document to analyze.
This is a convenience method that creates an instance of theInputConfiguration.Builderavoiding the need to create one manually viaInputConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toinputConfiguration(InputConfiguration).- Parameters:
inputConfiguration- a consumer that will call methods onInputConfiguration.Builder- 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 StartDocumentInsightsRequest.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:
-
projectArn
The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.
- Parameters:
projectArn- The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprints
The blueprints used to extract custom structured output from the document.
- Parameters:
blueprints- The blueprints used to extract custom structured output from the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprints
The blueprints used to extract custom structured output from the document.
- Parameters:
blueprints- The blueprints used to extract custom structured output from the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprints
The blueprints used to extract custom structured output from the document.
This is a convenience method that creates an instance of theBlueprintItem.Builderavoiding the need to create one manually viaBlueprintItem.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toblueprints(List<BlueprintItem>).- Parameters:
blueprints- a consumer that will call methods onBlueprintItem.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionConfiguration
StartDocumentInsightsRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The AWS KMS encryption configuration used to encrypt the analysis output. If you don't specify a value, Amazon Textract encrypts the output using an AWS owned key.
- Parameters:
encryptionConfiguration- The AWS KMS encryption configuration used to encrypt the analysis output. If you don't specify a value, Amazon Textract encrypts the output using an AWS owned key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfiguration
default StartDocumentInsightsRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) The AWS KMS encryption configuration used to encrypt the analysis output. If you don't specify a value, Amazon Textract encrypts the output using an AWS owned key.
This is a convenience method that creates an instance of theEncryptionConfiguration.Builderavoiding the need to create one manually viaEncryptionConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toencryptionConfiguration(EncryptionConfiguration).- Parameters:
encryptionConfiguration- a consumer that will call methods onEncryptionConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notificationConfiguration
StartDocumentInsightsRequest.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration) Notification settings for the job.
- Parameters:
notificationConfiguration- Notification settings for the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfiguration
default StartDocumentInsightsRequest.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Notification settings for the job.
This is a convenience method that creates an instance of theNotificationConfiguration.Builderavoiding the need to create one manually viaNotificationConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tonotificationConfiguration(NotificationConfiguration).- Parameters:
notificationConfiguration- a consumer that will call methods onNotificationConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
A set of tags (key-value pairs) to assign to the document insights job.
- Parameters:
tags- A set of tags (key-value pairs) to assign to the document insights job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartDocumentInsightsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartDocumentInsightsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-