Class CreateProjectRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateProjectRequest.Builder,CreateProjectRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CreateProjectRequest.Builderbuilder()final StringA unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time.final CustomConfigurationThe configuration that associates blueprints with the project for custom output extraction.final EncryptionConfigurationThe AWS KMS encryption configuration used to encrypt the project at rest.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExtractionConfigurationThe configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.final GenerativeConfigurationThe configuration that controls generative capabilities such as summarization and figure captioning.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final StringA description of the project.final StringA unique name for the project.The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).static Class<? extends CreateProjectRequest.Builder> final SplitterConfigurationThe configuration that controls whether multi-document packets are split into individual documents.tags()A set of tags (key-value pairs) to assign to the project.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
-
clientRequestToken
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.
-
projectName
A unique name for the project.
- Returns:
- A unique name for the project.
-
projectDescription
A description of the project.
- Returns:
- A description of the project.
-
extractionConfiguration
The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.
- Returns:
- The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.
-
generativeConfiguration
The configuration that controls generative capabilities such as summarization and figure captioning.
- Returns:
- The configuration that controls generative capabilities such as summarization and figure captioning.
-
customConfiguration
The configuration that associates blueprints with the project for custom output extraction.
- Returns:
- The configuration that associates blueprints with the project for custom output extraction.
-
splitterConfiguration
The configuration that controls whether multi-document packets are split into individual documents.
- Returns:
- The configuration that controls whether multi-document packets are split into individual documents.
-
sensitiveDataConfiguration
The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).
- Returns:
- The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).
-
encryptionConfiguration
The AWS KMS encryption configuration used to encrypt the project at rest. If you don't specify a value, Amazon Textract encrypts the project using an AWS owned key.
- Returns:
- The AWS KMS encryption configuration used to encrypt the project at rest. If you don't specify a value, Amazon Textract encrypts the project using an AWS owned key.
-
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 project.
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 project.
-
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<CreateProjectRequest.Builder,CreateProjectRequest> - 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.
-