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

Interface StartDocumentAnalysisRequest.Builder

    • Method Detail

      • documentLocation

        StartDocumentAnalysisRequest.Builder documentLocation​(DocumentLocation documentLocation)

        The location of the document to be processed.

        Parameters:
        documentLocation - The location of the document to be processed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featureTypesWithStrings

        StartDocumentAnalysisRequest.Builder featureTypesWithStrings​(Collection<String> featureTypes)

        A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

        Parameters:
        featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featureTypesWithStrings

        StartDocumentAnalysisRequest.Builder featureTypesWithStrings​(String... featureTypes)

        A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

        Parameters:
        featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featureTypes

        StartDocumentAnalysisRequest.Builder featureTypes​(Collection<FeatureType> featureTypes)

        A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

        Parameters:
        featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featureTypes

        StartDocumentAnalysisRequest.Builder featureTypes​(FeatureType... featureTypes)

        A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

        Parameters:
        featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        StartDocumentAnalysisRequest.Builder clientRequestToken​(String clientRequestToken)

        The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis 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.

        Parameters:
        clientRequestToken - The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis 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:
        Returns a reference to this object so that method calls can be chained together.

      • jobTag

        StartDocumentAnalysisRequest.Builder jobTag​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • notificationChannel

        StartDocumentAnalysisRequest.Builder notificationChannel​(NotificationChannel notificationChannel)

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

        Parameters:
        notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputConfig

        StartDocumentAnalysisRequest.Builder outputConfig​(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 by the GetDocumentAnalysis operation.

        Parameters:
        outputConfig - Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        StartDocumentAnalysisRequest.Builder kmsKeyId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • queriesConfig

        StartDocumentAnalysisRequest.Builder queriesConfig​(QueriesConfig queriesConfig)
        Sets the value of the QueriesConfig property for this object.
        Parameters:
        queriesConfig - The new value for the QueriesConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • adaptersConfig

        StartDocumentAnalysisRequest.Builder adaptersConfig​(AdaptersConfig adaptersConfig)

        Specifies the adapter to be used when analyzing a document.

        Parameters:
        adaptersConfig - Specifies the adapter to be used when analyzing a document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.