Package com.azure.search.documents.indexes.models

Class IndexingParametersConfiguration

java.lang.Object
com.azure.search.documents.indexes.models.IndexingParametersConfiguration
public final class IndexingParametersConfiguration extends Object
A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

  • Constructor Details

    • IndexingParametersConfiguration

      public IndexingParametersConfiguration()

  • Method Details

    • getParsingMode

      public BlobIndexerParsingMode getParsingMode()
      Get the parsingMode property: Represents the parsing mode for indexing from an Azure blob data source.
      Returns:
      the parsingMode value.

    • setParsingMode

      public IndexingParametersConfiguration setParsingMode(BlobIndexerParsingMode parsingMode)
      Set the parsingMode property: Represents the parsing mode for indexing from an Azure blob data source.
      Parameters:
      parsingMode - the parsingMode value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getExcludedFileNameExtensions

      public String getExcludedFileNameExtensions()
      Get the excludedFileNameExtensions property: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing.
      Returns:
      the excludedFileNameExtensions value.

    • setExcludedFileNameExtensions

      public IndexingParametersConfiguration setExcludedFileNameExtensions(String excludedFileNameExtensions)
      Set the excludedFileNameExtensions property: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing.
      Parameters:
      excludedFileNameExtensions - the excludedFileNameExtensions value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getIndexedFileNameExtensions

      public String getIndexedFileNameExtensions()
      Get the indexedFileNameExtensions property: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types.
      Returns:
      the indexedFileNameExtensions value.

    • setIndexedFileNameExtensions

      public IndexingParametersConfiguration setIndexedFileNameExtensions(String indexedFileNameExtensions)
      Set the indexedFileNameExtensions property: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types.
      Parameters:
      indexedFileNameExtensions - the indexedFileNameExtensions value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • isFailOnUnsupportedContentType

      public Boolean isFailOnUnsupportedContentType()
      Get the failOnUnsupportedContentType property: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance.
      Returns:
      the failOnUnsupportedContentType value.

    • setFailOnUnsupportedContentType

      public IndexingParametersConfiguration setFailOnUnsupportedContentType(Boolean failOnUnsupportedContentType)
      Set the failOnUnsupportedContentType property: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance.
      Parameters:
      failOnUnsupportedContentType - the failOnUnsupportedContentType value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • isFailOnUnprocessableDocument

      public Boolean isFailOnUnprocessableDocument()
      Get the failOnUnprocessableDocument property: For Azure blobs, set to false if you want to continue indexing if a document fails indexing.
      Returns:
      the failOnUnprocessableDocument value.

    • setFailOnUnprocessableDocument

      public IndexingParametersConfiguration setFailOnUnprocessableDocument(Boolean failOnUnprocessableDocument)
      Set the failOnUnprocessableDocument property: For Azure blobs, set to false if you want to continue indexing if a document fails indexing.
      Parameters:
      failOnUnprocessableDocument - the failOnUnprocessableDocument value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • isIndexStorageMetadataOnlyForOversizedDocuments

      public Boolean isIndexStorageMetadataOnlyForOversizedDocuments()
      Get the indexStorageMetadataOnlyForOversizedDocuments property: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity.
      Returns:
      the indexStorageMetadataOnlyForOversizedDocuments value.

    • setIndexStorageMetadataOnlyForOversizedDocuments

      public IndexingParametersConfiguration setIndexStorageMetadataOnlyForOversizedDocuments(Boolean indexStorageMetadataOnlyForOversizedDocuments)
      Set the indexStorageMetadataOnlyForOversizedDocuments property: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity.
      Parameters:
      indexStorageMetadataOnlyForOversizedDocuments - the indexStorageMetadataOnlyForOversizedDocuments value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getDelimitedTextHeaders

      public String getDelimitedTextHeaders()
      Get the delimitedTextHeaders property: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index.
      Returns:
      the delimitedTextHeaders value.

    • setDelimitedTextHeaders

      public IndexingParametersConfiguration setDelimitedTextHeaders(String delimitedTextHeaders)
      Set the delimitedTextHeaders property: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index.
      Parameters:
      delimitedTextHeaders - the delimitedTextHeaders value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getDelimitedTextDelimiter

      public String getDelimitedTextDelimiter()
      Get the delimitedTextDelimiter property: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|").
      Returns:
      the delimitedTextDelimiter value.

    • setDelimitedTextDelimiter

      public IndexingParametersConfiguration setDelimitedTextDelimiter(String delimitedTextDelimiter)
      Set the delimitedTextDelimiter property: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|").
      Parameters:
      delimitedTextDelimiter - the delimitedTextDelimiter value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • isFirstLineContainsHeaders

      public Boolean isFirstLineContainsHeaders()
      Get the firstLineContainsHeaders property: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers.
      Returns:
      the firstLineContainsHeaders value.

    • setFirstLineContainsHeaders

      public IndexingParametersConfiguration setFirstLineContainsHeaders(Boolean firstLineContainsHeaders)
      Set the firstLineContainsHeaders property: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers.
      Parameters:
      firstLineContainsHeaders - the firstLineContainsHeaders value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getDocumentRoot

      public String getDocumentRoot()
      Get the documentRoot property: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property.
      Returns:
      the documentRoot value.

    • setDocumentRoot

      public IndexingParametersConfiguration setDocumentRoot(String documentRoot)
      Set the documentRoot property: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property.
      Parameters:
      documentRoot - the documentRoot value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getDataToExtract

      public BlobIndexerDataToExtract getDataToExtract()
      Get the dataToExtract property: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs.
      Returns:
      the dataToExtract value.

    • setDataToExtract

      public IndexingParametersConfiguration setDataToExtract(BlobIndexerDataToExtract dataToExtract)
      Set the dataToExtract property: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs.
      Parameters:
      dataToExtract - the dataToExtract value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getImageAction

      public BlobIndexerImageAction getImageAction()
      Get the imageAction property: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer.
      Returns:
      the imageAction value.

    • setImageAction

      public IndexingParametersConfiguration setImageAction(BlobIndexerImageAction imageAction)
      Set the imageAction property: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer.
      Parameters:
      imageAction - the imageAction value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • isAllowSkillsetToReadFileData

      public Boolean isAllowSkillsetToReadFileData()
      Get the allowSkillsetToReadFileData property: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill.
      Returns:
      the allowSkillsetToReadFileData value.

    • setAllowSkillsetToReadFileData

      public IndexingParametersConfiguration setAllowSkillsetToReadFileData(Boolean allowSkillsetToReadFileData)
      Set the allowSkillsetToReadFileData property: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill.
      Parameters:
      allowSkillsetToReadFileData - the allowSkillsetToReadFileData value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getPdfTextRotationAlgorithm

      public BlobIndexerPdfTextRotationAlgorithm getPdfTextRotationAlgorithm()
      Get the pdfTextRotationAlgorithm property: Determines algorithm for text extraction from PDF files in Azure blob storage.
      Returns:
      the pdfTextRotationAlgorithm value.

    • setPdfTextRotationAlgorithm

      public IndexingParametersConfiguration setPdfTextRotationAlgorithm(BlobIndexerPdfTextRotationAlgorithm pdfTextRotationAlgorithm)
      Set the pdfTextRotationAlgorithm property: Determines algorithm for text extraction from PDF files in Azure blob storage.
      Parameters:
      pdfTextRotationAlgorithm - the pdfTextRotationAlgorithm value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getExecutionEnvironment

      public IndexerExecutionEnvironment getExecutionEnvironment()
      Get the executionEnvironment property: Specifies the environment in which the indexer should execute.
      Returns:
      the executionEnvironment value.

    • setExecutionEnvironment

      public IndexingParametersConfiguration setExecutionEnvironment(IndexerExecutionEnvironment executionEnvironment)
      Set the executionEnvironment property: Specifies the environment in which the indexer should execute.
      Parameters:
      executionEnvironment - the executionEnvironment value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getQueryTimeout

      public String getQueryTimeout()
      Get the queryTimeout property: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss".
      Returns:
      the queryTimeout value.

    • setQueryTimeout

      public IndexingParametersConfiguration setQueryTimeout(String queryTimeout)
      Set the queryTimeout property: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss".
      Parameters:
      queryTimeout - the queryTimeout value to set.
      Returns:
      the IndexingParametersConfiguration object itself.

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Get the additionalProperties property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
      Returns:
      the additionalProperties value.

    • setAdditionalProperties

      public IndexingParametersConfiguration setAdditionalProperties(Map<String,Object> additionalProperties)
      Set the additionalProperties property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
      Parameters:
      additionalProperties - the additionalProperties value to set.
      Returns:
      the IndexingParametersConfiguration object itself.