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

Class StartDocumentTextDetectionRequest

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.StartDocumentTextDetectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartDocumentTextDetectionRequest extends TextractRequest implements ToCopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>

  • Method Details

    • documentLocation

      public final DocumentLocation documentLocation()

      The location of the document to be processed.

      Returns:
      The location of the document to be processed.

    • clientRequestToken

      public final String clientRequestToken()

      The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 that's 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 that's 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()

      The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

      Returns:
      The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

    • outputConfig

      public final OutputConfig outputConfig()

      Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

      Returns:
      Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

    • 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 StartDocumentTextDetectionRequest.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<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>
      Specified by:
      toBuilder in class TextractRequest
      Returns:
      a builder for type T

    • builder

      public static StartDocumentTextDetectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartDocumentTextDetectionRequest.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.