Class UpdateProjectRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateProjectRequest.Builder,UpdateProjectRequest>

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

    • projectArn

      public final String projectArn()

      The Amazon Resource Name (ARN) of the project to update.

      Returns:
      The Amazon Resource Name (ARN) of the project to update.
    • projectDescription

      public final String projectDescription()

      The updated description of the project.

      Returns:
      The updated description of the project.
    • extractionConfiguration

      public final ExtractionConfiguration extractionConfiguration()

      The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format. Replaces the stored extraction configuration.

      Returns:
      The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format. Replaces the stored extraction configuration.
    • generativeConfiguration

      public final GenerativeConfiguration generativeConfiguration()

      The configuration that controls generative capabilities such as summarization and figure captioning. Replaces the stored generative configuration, so a capability that you omit is turned off.

      Returns:
      The configuration that controls generative capabilities such as summarization and figure captioning. Replaces the stored generative configuration, so a capability that you omit is turned off.
    • customConfiguration

      public final CustomConfiguration customConfiguration()

      The configuration that associates blueprints with the project for custom output extraction. Replaces the stored custom configuration. To disable custom configuration, specify an empty Blueprints list.

      Returns:
      The configuration that associates blueprints with the project for custom output extraction. Replaces the stored custom configuration. To disable custom configuration, specify an empty Blueprints list.
    • splitterConfiguration

      public final SplitterConfiguration splitterConfiguration()

      The configuration that controls whether multi-document packets are split into individual documents. Replaces the stored splitter configuration.

      Returns:
      The configuration that controls whether multi-document packets are split into individual documents. Replaces the stored splitter configuration.
    • sensitiveDataConfiguration

      public final SensitiveDataConfiguration sensitiveDataConfiguration()

      The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII). Replaces the stored sensitive data configuration. To turn off detection, set DetectionMode to DISABLED.

      Returns:
      The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII). Replaces the stored sensitive data configuration. To turn off detection, set DetectionMode to DISABLED.
    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The AWS KMS encryption configuration used to encrypt the project at rest.

      Returns:
      The AWS KMS encryption configuration used to encrypt the project at rest.
    • toBuilder

      public UpdateProjectRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateProjectRequest.Builder,UpdateProjectRequest>
      Specified by:
      toBuilder in class TextractRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateProjectRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateProjectRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.