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

Class OutputConfig

java.lang.Object
software.amazon.awssdk.services.textract.model.OutputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>
@Generated("software.amazon.awssdk:codegen") public final class OutputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

See Also:

  • Method Details

    • s3Bucket

      public final String s3Bucket()

      The name of the bucket your output will go to.

      Returns:
      The name of the bucket your output will go to.

    • s3Prefix

      public final String s3Prefix()

      The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

      Returns:
      The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

    • toBuilder

      public OutputConfig.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<OutputConfig.Builder,OutputConfig>
      Returns:
      a builder for type T

    • builder

      public static OutputConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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