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

Class StartLendingAnalysisRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.textract.model.TextractRequest

software.amazon.awssdk.services.textract.model.StartLendingAnalysisRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartLendingAnalysisRequest
extends TextractRequest
implements ToCopyableBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartLendingAnalysisRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartLendingAnalysisRequest.Builder	builder()
String	clientRequestToken()	The idempotent token that you use to identify the start request.
DocumentLocation	documentLocation()	Returns the value of the DocumentLocation property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTag()	An identifier that you specify to be included in the completion notification published to the Amazon SNS topic.
String	kmsKeyId()	The KMS key used to encrypt the inference results.
NotificationChannel	notificationChannel()	Returns the value of the NotificationChannel property for this object.
OutputConfig	outputConfig()	Returns the value of the OutputConfig property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartLendingAnalysisRequest.Builder>	serializableBuilderClass()
StartLendingAnalysisRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

documentLocation

public final DocumentLocation documentLocation()

Returns the value of the DocumentLocation property for this object.

Returns:

The value of the DocumentLocation property for this object.

clientRequestToken

public final 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.

Returns:

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.

jobTag

public final 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).

Returns:

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

notificationChannel

public final NotificationChannel notificationChannel()

Returns the value of the NotificationChannel property for this object.

Returns:

The value of the NotificationChannel property for this object.

outputConfig

public final OutputConfig outputConfig()

Returns the value of the OutputConfig property for this object.

Returns:

The value of the OutputConfig property for this object.

kmsKeyId

public final 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.

Returns:

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.

toBuilder

public StartLendingAnalysisRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartLendingAnalysisRequest.Builder,StartLendingAnalysisRequest>

Specified by:

toBuilder in class TextractRequest

builder

public static StartLendingAnalysisRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartLendingAnalysisRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo