Package software.amazon.awssdk.services.textract.model

Interface StartLendingAnalysisRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>, SdkBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>, SdkPojo, SdkRequest.Builder, TextractRequest.Builder

Enclosing class:

StartLendingAnalysisRequest

public static interface StartLendingAnalysisRequest.Builder
extends TextractRequest.Builder, SdkPojo, CopyableBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>

Method Summary

Modifier and Type	Method	Description
StartLendingAnalysisRequest.Builder	clientRequestToken(String clientRequestToken)	The idempotent token that you use to identify the start request.
default StartLendingAnalysisRequest.Builder	documentLocation(Consumer<DocumentLocation.Builder> documentLocation)	Sets the value of the DocumentLocation property for this object.
StartLendingAnalysisRequest.Builder	documentLocation(DocumentLocation documentLocation)	Sets the value of the DocumentLocation property for this object.
StartLendingAnalysisRequest.Builder	jobTag(String jobTag)	An identifier that you specify to be included in the completion notification published to the Amazon SNS topic.
StartLendingAnalysisRequest.Builder	kmsKeyId(String kmsKeyId)	The KMS key used to encrypt the inference results.
default StartLendingAnalysisRequest.Builder	notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)	Sets the value of the NotificationChannel property for this object.
StartLendingAnalysisRequest.Builder	notificationChannel(NotificationChannel notificationChannel)	Sets the value of the NotificationChannel property for this object.
default StartLendingAnalysisRequest.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig)	Sets the value of the OutputConfig property for this object.
StartLendingAnalysisRequest.Builder	outputConfig(OutputConfig outputConfig)	Sets the value of the OutputConfig property for this object.
StartLendingAnalysisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartLendingAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.textract.model.TextractRequest.Builder

build

Method Details

documentLocation

StartLendingAnalysisRequest.Builder documentLocation(DocumentLocation documentLocation)

Sets the value of the DocumentLocation property for this object.

Parameters:

documentLocation - The new value for the DocumentLocation property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentLocation

default StartLendingAnalysisRequest.Builder documentLocation(Consumer<DocumentLocation.Builder> documentLocation)

Sets the value of the DocumentLocation property for this object. This is a convenience method that creates an instance of the DocumentLocation.Builder avoiding the need to create one manually via DocumentLocation.builder().

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

Parameters:

documentLocation - a consumer that will call methods on DocumentLocation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentLocation(DocumentLocation)

clientRequestToken

StartLendingAnalysisRequest.Builder clientRequestToken(String clientRequestToken)

The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Parameters:

clientRequestToken - The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobTag

StartLendingAnalysisRequest.Builder jobTag(String jobTag)

An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Parameters:

jobTag - An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationChannel

StartLendingAnalysisRequest.Builder notificationChannel(NotificationChannel notificationChannel)

Sets the value of the NotificationChannel property for this object.

Parameters:

notificationChannel - The new value for the NotificationChannel property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationChannel

default StartLendingAnalysisRequest.Builder notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)

Sets the value of the NotificationChannel property for this object. This is a convenience method that creates an instance of the NotificationChannel.Builder avoiding the need to create one manually via NotificationChannel.builder().

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

Parameters:

notificationChannel - a consumer that will call methods on NotificationChannel.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• notificationChannel(NotificationChannel)

outputConfig

StartLendingAnalysisRequest.Builder outputConfig(OutputConfig outputConfig)

Sets the value of the OutputConfig property for this object.

Parameters:

outputConfig - The new value for the OutputConfig property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputConfig

default StartLendingAnalysisRequest.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

Sets the value of the OutputConfig property for this object. This is a convenience method that creates an instance of the OutputConfig.Builder avoiding the need to create one manually via OutputConfig.builder().

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

Parameters:

outputConfig - a consumer that will call methods on OutputConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• outputConfig(OutputConfig)

kmsKeyId

StartLendingAnalysisRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.

Parameters:

kmsKeyId - The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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