Class StartDocumentInsightsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<StartDocumentInsightsRequest.Builder,StartDocumentInsightsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<BlueprintItem> The blueprints used to extract custom structured output from the document.builder()final EncryptionConfigurationThe AWS KMS encryption configuration used to encrypt the analysis output.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the Blueprints property.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final InputConfigurationThe Amazon S3 location of the input document to analyze.Notification settings for the job.final OutputConfigurationThe Amazon S3 location where the analysis results are written.final StringThe Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.static Class<? extends StartDocumentInsightsRequest.Builder> tags()A set of tags (key-value pairs) to assign to the document insights job.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
inputConfiguration
The Amazon S3 location of the input document to analyze.
- Returns:
- The Amazon S3 location of the input document to analyze.
-
outputConfiguration
The Amazon S3 location where the analysis results are written.
- Returns:
- The Amazon S3 location where the analysis results are written.
-
projectArn
The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.
- Returns:
- The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.
-
hasBlueprints
public final boolean hasBlueprints()For responses, this returns true if the service returned a value for the Blueprints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
blueprints
The blueprints used to extract custom structured output from the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBlueprints()method.- Returns:
- The blueprints used to extract custom structured output from the document.
-
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:
- 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.
-
notificationConfiguration
Notification settings for the job.
- Returns:
- Notification settings for the job.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A set of tags (key-value pairs) to assign to the document insights job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- A set of tags (key-value pairs) to assign to the document insights job.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<StartDocumentInsightsRequest.Builder,StartDocumentInsightsRequest> - Specified by:
toBuilderin classTextractRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-