Uses of Annotation Type
org.apache.tika.config.Field

Packages that use Field

Package	Description
org.apache.tika.detect	Media type detection.
org.apache.tika.detect.magika
org.apache.tika.detect.siegfried
org.apache.tika.detect.zip
org.apache.tika.extractor	Extraction of component documents.
org.apache.tika.langdetect.opennlp.metadatafilter
org.apache.tika.langdetect.optimaize.metadatafilter
org.apache.tika.metadata.filter
org.apache.tika.parser	Tika parsers.
org.apache.tika.parser.csv
org.apache.tika.parser.digestutils
org.apache.tika.parser.dwg
org.apache.tika.parser.epub
org.apache.tika.parser.external2
org.apache.tika.parser.gdal
org.apache.tika.parser.geo.topic
org.apache.tika.parser.geopkg
org.apache.tika.parser.html
org.apache.tika.parser.html.charsetdetector
org.apache.tika.parser.image
org.apache.tika.parser.microsoft
org.apache.tika.parser.microsoft.libpst
org.apache.tika.parser.microsoft.rtf
org.apache.tika.parser.mp3
org.apache.tika.parser.ocr
org.apache.tika.parser.odf
org.apache.tika.parser.pdf
org.apache.tika.parser.pkg
org.apache.tika.parser.recognition
org.apache.tika.parser.recognition.tf
org.apache.tika.parser.strings
org.apache.tika.parser.transcribe.aws
org.apache.tika.parser.txt
org.apache.tika.parser.wordperfect
org.apache.tika.pipes
org.apache.tika.pipes.emitter.azblob
org.apache.tika.pipes.emitter.fs
org.apache.tika.pipes.emitter.gcs
org.apache.tika.pipes.emitter.jdbc
org.apache.tika.pipes.emitter.kafka
org.apache.tika.pipes.emitter.opensearch
org.apache.tika.pipes.emitter.s3
org.apache.tika.pipes.emitter.solr
org.apache.tika.pipes.fetcher
org.apache.tika.pipes.fetcher.azblob
org.apache.tika.pipes.fetcher.fs
org.apache.tika.pipes.fetcher.gcs
org.apache.tika.pipes.fetcher.http
org.apache.tika.pipes.fetcher.s3
org.apache.tika.pipes.fetchers.microsoftgraph
org.apache.tika.pipes.pipesiterator
org.apache.tika.pipes.pipesiterator.azblob
org.apache.tika.pipes.pipesiterator.csv
org.apache.tika.pipes.pipesiterator.filelist
org.apache.tika.pipes.pipesiterator.fs
org.apache.tika.pipes.pipesiterator.gcs
org.apache.tika.pipes.pipesiterator.jdbc
org.apache.tika.pipes.pipesiterator.kafka
org.apache.tika.pipes.pipesiterator.s3
org.apache.tika.pipes.pipesiterator.solr
org.apache.tika.pipes.reporters.fs
org.apache.tika.pipes.reporters.jdbc
org.apache.tika.pipes.reporters.opensearch

Uses of Field in org.apache.tika.detect

Methods in org.apache.tika.detect with annotations of type Field

Modifier and Type	Method	Description
void	FileCommandDetector.setFilePath(String fileCommandPath)
void	FileCommandDetector.setMaxBytes(int maxBytes)	If this is not called on a TikaInputStream, this detector will spool up to this many bytes to a file to be detected by the 'file' command.
void	FileCommandDetector.setTimeoutMs(long timeoutMs)
void	FileCommandDetector.setUseMime(boolean useMime)

Uses of Field in org.apache.tika.detect.magika

Methods in org.apache.tika.detect.magika with annotations of type Field

Modifier and Type	Method	Description
void	MagikaDetector.setMagikaPath(String fileCommandPath)
void	MagikaDetector.setMaxBytes(int maxBytes)	If this is not called on a TikaInputStream, this detector will spool up to this many bytes to a file to be detected by the 'file' command.
void	MagikaDetector.setTimeoutMs(long timeoutMs)
void	MagikaDetector.setUseMime(boolean useMime)	As default behavior, Tika runs magika to add its detection to the metadata, but NOT to use detection in determining parsers etc.

Uses of Field in org.apache.tika.detect.siegfried

Methods in org.apache.tika.detect.siegfried with annotations of type Field

Modifier and Type	Method	Description
void	SiegfriedDetector.setMaxBytes(int maxBytes)	If this is not called on a TikaInputStream, this detector will spool up to this many bytes to a file to be detected by the 'file' command.
void	SiegfriedDetector.setSiegfriedPath(String fileCommandPath)
void	SiegfriedDetector.setTimeoutMs(long timeoutMs)
void	SiegfriedDetector.setUseMime(boolean useMime)	As default behavior, Tika runs Siegfried to add its detection to the metadata, but NOT to use detection in determining parsers etc.

Uses of Field in org.apache.tika.detect.zip

Methods in org.apache.tika.detect.zip with annotations of type Field

Modifier and Type	Method	Description
void	DefaultZipContainerDetector.setMarkLimit(int markLimit)	If this is less than 0 and a TikaInputStream is used, the file will be spooled to disk, and detection will run on the full file.

Uses of Field in org.apache.tika.extractor

Methods in org.apache.tika.extractor with annotations of type Field

Modifier and Type	Method	Description
void	RUnpackExtractorFactory.setEmbeddedBytesExcludeEmbeddedResourceTypes(List<String> excludeAttachmentTypes)
void	RUnpackExtractorFactory.setEmbeddedBytesExcludeMimeTypes(List<String> excludeMimeTypes)
void	RUnpackExtractorFactory.setEmbeddedBytesIncludeEmbeddedResourceTypes(List<String> includeAttachmentTypes)
void	RUnpackExtractorFactory.setEmbeddedBytesIncludeMimeTypes(List<String> includeMimeTypes)
void	RUnpackExtractorFactory.setMaxEmbeddedBytesForExtraction(long maxEmbeddedBytesForExtraction)	Total number of bytes to write out.
void	ParsingEmbeddedDocumentExtractorFactory.setWriteFileNameToContent(boolean writeFileNameToContent)
void	RUnpackExtractorFactory.setWriteFileNameToContent(boolean writeFileNameToContent)

Uses of Field in org.apache.tika.langdetect.opennlp.metadatafilter

Methods in org.apache.tika.langdetect.opennlp.metadatafilter with annotations of type Field

Modifier and Type	Method	Description
void	OpenNLPMetadataFilter.setMaxCharsForDetection(int maxCharsForDetection)

Uses of Field in org.apache.tika.langdetect.optimaize.metadatafilter

Methods in org.apache.tika.langdetect.optimaize.metadatafilter with annotations of type Field

Modifier and Type	Method	Description
void	OptimaizeMetadataFilter.setMaxCharsForDetection(int maxCharsForDetection)

Uses of Field in org.apache.tika.metadata.filter

Methods in org.apache.tika.metadata.filter with annotations of type Field

Modifier and Type	Method	Description
void	DateNormalizingMetadataFilter.setDefaultTimeZone(String timeZoneId)
void	ExcludeFieldMetadataFilter.setExclude(List<String> exclude)
void	FieldNameMappingFilter.setExcludeUnmapped(boolean excludeUnmapped)	If this is true (default), this means that only the fields that have a "from" value in the mapper will be passed through.
void	GeoPointMetadataFilter.setGeoPointFieldName(String geoPointFieldName)	Set the field for the concatenated LATITUDE,LONGITUDE string.
void	IncludeFieldMetadataFilter.setInclude(List<String> include)
void	FieldNameMappingFilter.setMappings(Map<String,String> mappings)
void	ClearByMimeMetadataFilter.setMimes(List<String> mimes)
void	CaptureGroupMetadataFilter.setRegex(String regex)
void	CaptureGroupMetadataFilter.setSourceField(String sourceField)
void	CaptureGroupMetadataFilter.setTargetField(String targetField)
void	ClearByAttachmentTypeMetadataFilter.setTypes(List<String> types)	For types see TikaCoreProperties.EmbeddedResourceType

Uses of Field in org.apache.tika.parser

Methods in org.apache.tika.parser with annotations of type Field

Modifier and Type	Method	Description
void	RegexCaptureParser.setCaptureMap(Map<String,String> map)
void	RegexCaptureParser.setMatchMap(Map<String,String> map)
void	RegexCaptureParser.setWriteContent(boolean writeContent)

Uses of Field in org.apache.tika.parser.csv

Methods in org.apache.tika.parser.csv with annotations of type Field

Modifier and Type	Method	Description
void	TextAndCSVParser.setNameToDelimiterMap(Map<String,String> map)

Uses of Field in org.apache.tika.parser.digestutils

Methods in org.apache.tika.parser.digestutils with annotations of type Field

Modifier and Type	Method	Description
void	CommonsDigesterFactory.setAlgorithmString(String algorithmString)
void	CommonsDigesterFactory.setMarkLimit(int markLimit)
void	CommonsDigesterFactory.setSkipContainerDocument(boolean skipContainerDocument)

Uses of Field in org.apache.tika.parser.dwg

Methods in org.apache.tika.parser.dwg with annotations of type Field

Modifier and Type	Method	Description
void	AbstractDWGParser.setCleanDwgReadOutput(boolean cleanDwgReadOutput)
void	AbstractDWGParser.setCleanDwgReadOutputBatchSize(int cleanDwgReadOutputBatchSize)
void	AbstractDWGParser.setCleanDwgReadRegexToReplace(String cleanDwgReadRegexToReplace)
void	AbstractDWGParser.setCleanDwgReadReplaceWith(String cleanDwgReadReplaceWith)
void	AbstractDWGParser.setDwgReadExecutable(String dwgReadExecutable)
void	AbstractDWGParser.setDwgReadTimeout(long dwgReadTimeout)

Uses of Field in org.apache.tika.parser.epub

Methods in org.apache.tika.parser.epub with annotations of type Field

Modifier and Type	Method	Description
void	EpubParser.setStreaming(boolean streaming)

Uses of Field in org.apache.tika.parser.external2

Methods in org.apache.tika.parser.external2 with annotations of type Field

Modifier and Type	Method	Description
void	ExternalParser.setCommandLine(List<String> commandLine)	Use this to specify the full commandLine.
void	ExternalParser.setMaxStdErr(int maxStdErr)
void	ExternalParser.setMaxStdOut(int maxStdOut)
void	ExternalParser.setOutputParser(Parser parser)	This parser is called on the output of the process.
void	ExternalParser.setReturnStderr(boolean returnStderr)	If set to true, this will return the stderr in the metadata via ExternalProcess.STD_ERR.
void	ExternalParser.setReturnStdout(boolean returnStdout)	If set to true, this will return the stdout in the metadata via ExternalProcess.STD_OUT.
void	ExternalParser.setSupportedTypes(List<String> supportedTypes)	This is set during initialization from a tika-config.
void	ExternalParser.setTimeoutMs(long timeoutMs)

Uses of Field in org.apache.tika.parser.gdal

Methods in org.apache.tika.parser.gdal with annotations of type Field

Modifier and Type	Method	Description
void	GDALParser.setMaxStdErr(int maxStdErr)
void	GDALParser.setMaxStdOut(int maxStdOut)
void	GDALParser.setTimeoutMs(long timeoutMs)

Uses of Field in org.apache.tika.parser.geo.topic

Methods in org.apache.tika.parser.geo.topic with annotations of type Field

Modifier and Type	Method	Description
void	GeoParser.setGazetteerRestEndpoint(String gazetteerRestEndpoint)
void	GeoParser.setNerModelUrl(String nerModelUrl)

Uses of Field in org.apache.tika.parser.geopkg

Methods in org.apache.tika.parser.geopkg with annotations of type Field

Modifier and Type	Method	Description
void	GeoPkgParser.setIgnoreBlobColumns(List<String> ignoreBlobColumns)

Uses of Field in org.apache.tika.parser.html

Methods in org.apache.tika.parser.html with annotations of type Field

Modifier and Type	Method	Description
void	JSoupParser.setExtractScripts(boolean extractScripts)	Whether or not to extract contents in script entities.
void	HtmlEncodingDetector.setMarkLimit(int markLimit)	How far into the stream to read for charset detection.

Uses of Field in org.apache.tika.parser.html.charsetdetector

Methods in org.apache.tika.parser.html.charsetdetector with annotations of type Field

Modifier and Type	Method	Description
void	StandardHtmlEncodingDetector.setMarkLimit(int markLimit)	How far into the stream to read for charset detection.

Uses of Field in org.apache.tika.parser.image

Methods in org.apache.tika.parser.image with annotations of type Field

Modifier and Type	Method	Description
void	PSDParser.setMaxDataLengthBytes(int maxDataLengthBytes)
void	BPGParser.setMaxRecordLength(int maxRecordLength)

Uses of Field in org.apache.tika.parser.microsoft

Methods in org.apache.tika.parser.microsoft with annotations of type Field

Modifier and Type	Method	Description
void	AbstractOfficeParser.setByteArrayMaxOverride(int maxOverride)	WARNING: this sets a static variable in POI.
void	AbstractOfficeParser.setConcatenatePhoneticRuns(boolean concatenatePhoneticRuns)
void	AbstractOfficeParser.setDateFormatOverride(String format)
void	AbstractOfficeParser.setExtractAllAlternativesFromMSG(boolean extractAllAlternativesFromMSG)	Some .msg files can contain body content in html, rtf and/or text.
void	AbstractOfficeParser.setExtractMacros(boolean extractMacros)
void	AbstractOfficeParser.setIncludeDeletedContent(boolean includeDeletedConent)
void	AbstractOfficeParser.setIncludeHeadersAndFooters(boolean includeHeadersAndFooters)
void	AbstractOfficeParser.setIncludeMoveFromContent(boolean includeMoveFromContent)
void	AbstractOfficeParser.setIncludeShapeBasedContent(boolean includeShapeBasedContent)
void	AbstractOfficeParser.setUseSAXDocxExtractor(boolean useSAXDocxExtractor)
void	AbstractOfficeParser.setUseSAXPptxExtractor(boolean useSAXPptxExtractor)
void	AbstractOfficeParser.setWriteSelectHeadersInBody(boolean val)	If set to true, this will write the to/from/cc into the body content

Uses of Field in org.apache.tika.parser.microsoft.libpst

Methods in org.apache.tika.parser.microsoft.libpst with annotations of type Field

Modifier and Type	Method	Description
void	LibPstParser.setIncludeDeleted(boolean includeDeleted)
void	LibPstParser.setMaxEmails(int maxEmails)
void	LibPstParser.setProcessEmailAsMsg(boolean processEmailAsMsg)
void	LibPstParser.setReadPstPath(String readPstPath)	This should include the path up to but not including 'readpst', e.g.
void	LibPstParser.setTimeoutSeconds(long timeoutSeconds)

Uses of Field in org.apache.tika.parser.microsoft.rtf

Methods in org.apache.tika.parser.microsoft.rtf with annotations of type Field

Modifier and Type	Method	Description
void	RTFParser.setMemoryLimitInKb(int memoryLimitInKb)

Uses of Field in org.apache.tika.parser.mp3

Methods in org.apache.tika.parser.mp3 with annotations of type Field

Modifier and Type	Method	Description
void	Mp3Parser.setMaxRecordSize(int maxRecordSize)	This statically sets the max record size in ID3v2Frame

Uses of Field in org.apache.tika.parser.ocr

Methods in org.apache.tika.parser.ocr with annotations of type Field

Modifier and Type	Method	Description
void	TesseractOCRParser.setApplyRotation(boolean applyRotation)
void	TesseractOCRParser.setColorspace(String colorspace)
void	TesseractOCRParser.setDensity(int density)
void	TesseractOCRParser.setDepth(int depth)
void	TesseractOCRParser.setEnableImagePreprocessing(boolean enableImagePreprocessing)
void	TesseractOCRParser.setFilter(String filter)
void	TesseractOCRParser.setImageMagickPath(String imageMagickPath)	Set the path to the ImageMagick executable directory, needed if it is not on system path.
void	TesseractOCRParser.setInlineContent(boolean inlineContent)
void	TesseractOCRParser.setLanguage(String language)
void	TesseractOCRParser.setMaxFileSizeToOcr(long maxFileSizeToOcr)
void	TesseractOCRParser.setMinFileSizeToOcr(long minFileSizeToOcr)
void	TesseractOCRParser.setOtherTesseractSettings(List<String> settings)
void	TesseractOCRParser.setOutputType(String outputType)
void	TesseractOCRParser.setPageSegMode(String pageSegMode)
void	TesseractOCRParser.setPreloadLangs(boolean preloadLangs)	If set to true and if tesseract is found, this will load the langs that result from --list-langs.
void	TesseractOCRParser.setPreserveInterwordSpacing(boolean preserveInterwordSpacing)
void	TesseractOCRParser.setResize(int resize)
void	TesseractOCRParser.setSkipOCR(boolean skipOCR)
void	TesseractOCRParser.setTessdataPath(String tessdataPath)	Set the path to the 'tessdata' folder, which contains language files and config files.
void	TesseractOCRParser.setTesseractPath(String tesseractPath)	Set the path to the Tesseract executable's directory, needed if it is not on system path.
void	TesseractOCRParser.setTimeout(int timeout)	Set default timeout in seconds.

Uses of Field in org.apache.tika.parser.odf

Methods in org.apache.tika.parser.odf with annotations of type Field

Modifier and Type	Method	Description
void	FlatOpenDocumentParser.setExtractMacros(boolean extractMacros)
void	OpenDocumentParser.setExtractMacros(boolean extractMacros)

Uses of Field in org.apache.tika.parser.pdf

Methods in org.apache.tika.parser.pdf with annotations of type Field

Modifier and Type	Method	Description
void	PDFParser.setAllowExtractionForAccessibility(boolean allowExtractionForAccessibility)
void	PDFParser.setAverageCharTolerance(float averageCharTolerance)
void	PDFParser.setCatchIntermediateExceptions(boolean catchIntermediateExceptions)
void	PDFParser.setDetectAngles(boolean detectAngles)
void	PDFParser.setDropThreshold(float dropThreshold)
void	PDFParser.setEnableAutoSpace(boolean v)	If true (the default), the parser should estimate where spaces should be inserted between words.
void	PDFParser.setExtractAcroFormContent(boolean extractAcroFormContent)
void	PDFParser.setExtractActions(boolean extractActions)
void	PDFParser.setExtractAnnotationText(boolean v)	If true (the default), text in annotations will be extracted.
void	PDFParser.setExtractBookmarksText(boolean extractBookmarksText)
void	PDFParser.setExtractFontNames(boolean extractFontNames)
void	PDFParser.setExtractIncrementalUpdateInfo(boolean setExtractIncrementalUpdateInfo)	Whether or not to scan a PDF for incremental updates.
void	PDFParser.setExtractInlineImageMetadataOnly(boolean extractInlineImageMetadataOnly)
void	PDFParser.setExtractInlineImages(boolean extractInlineImages)
void	PDFParser.setExtractMarkedContent(boolean extractMarkedContent)
void	PDFParser.setExtractUniqueInlineImagesOnly(boolean extractUniqueInlineImagesOnly)
void	PDFParser.setIfXFAExtractOnlyXFA(boolean ifXFAExtractOnlyXFA)
void	PDFParser.setIgnoreContentStreamSpaceGlyphs(boolean v)	If true, the parser should ignore spaces in the content stream and rely purely on the algorithm to determine where word breaks are (PDFBOX-3774).
void	PDFParser.setImageGraphicsEngineFactory(ImageGraphicsEngineFactory imageGraphicsEngineFactory)
void	PDFParser.setImageStrategy(String imageStrategy)
void	PDFParser.setMaxIncrementalUpdates(int maxIncrementalUpdates)	Set the maximum number of incremental updates to parse
void	PDFParser.setMaxMainMemoryBytes(long maxMainMemoryBytes)
void	PDFParser.setOcrDPI(int dpi)
void	PDFParser.setOcrImageFormatName(String formatName)
void	PDFParser.setOcrImageQuality(float imageQuality)
void	PDFParser.setOcrImageType(String imageType)
void	PDFParser.setOcrRenderingStrategy(String ocrRenderingStrategy)
void	PDFParser.setOcrStrategy(String ocrStrategyString)
void	PDFParser.setOcrStrategyAuto(String ocrStrategyAuto)
void	PDFParser.setParseIncrementalUpdates(boolean parseIncrementalUpdates)	If set to true, this will parse incremental updates if they exist within a PDF.
void	PDFParser.setSetKCMS(boolean setKCMS)
void	PDFParser.setSortByPosition(boolean v)	If true, sort text tokens by their x/y position before extracting text.
void	PDFParser.setSpacingTolerance(float spacingTolerance)
void	PDFParser.setSuppressDuplicateOverlappingText(boolean v)	If true, the parser should try to remove duplicated text over the same region.
void	PDFParser.setThrowOnEncryptedPayload(boolean throwOnEncryptedPayload)	If the file is a 'Collection' and contains an embedded file with a defined 'AssociatedFile' value of 'EncryptedPayload', then throw an EncryptedDocumentException.

Uses of Field in org.apache.tika.parser.pkg

Methods in org.apache.tika.parser.pkg with annotations of type Field

Modifier and Type	Method	Description
void	CompressorParser.setDecompressConcatenated(boolean decompressConcatenated)
void	PackageParser.setDetectCharsetsInEntryNames(boolean detectCharsetsInEntryNames)	Whether or not to run the default charset detector against entry names in ZipFiles.
void	CompressorParser.setMemoryLimitInKb(int memoryLimitInKb)

Uses of Field in org.apache.tika.parser.recognition

Methods in org.apache.tika.parser.recognition with annotations of type Field

Modifier and Type	Method	Description
void	ObjectRecognitionParser.setRecogniser(String recogniserClass)

Uses of Field in org.apache.tika.parser.recognition.tf

Fields in org.apache.tika.parser.recognition.tf with annotations of type Field

Modifier and Type	Field	Description
protected URI	TensorflowRESTRecogniser.apiBaseUri
protected double	TensorflowRESTRecogniser.minConfidence
protected int	TensorflowRESTRecogniser.topN

Uses of Field in org.apache.tika.parser.strings

Methods in org.apache.tika.parser.strings with annotations of type Field

Modifier and Type	Method	Description
void	StringsParser.setEncoding(String encoding)
void	StringsParser.setMinLength(int minLength)
void	StringsParser.setStringsPath(String path)	Sets the "strings" installation folder.
void	StringsParser.setTimeoutSeconds(int timeoutSeconds)

Uses of Field in org.apache.tika.parser.transcribe.aws

Methods in org.apache.tika.parser.transcribe.aws with annotations of type Field

Modifier and Type	Method	Description
void	AmazonTranscribe.setBucket(String bucket)	Sets the client secret for the transcriber API.
void	AmazonTranscribe.setClientId(String id)	Sets the client Id for the transcriber API.
void	AmazonTranscribe.setClientSecret(String secret)	Sets the client secret for the transcriber API.
void	AmazonTranscribe.setRegion(String region)

Uses of Field in org.apache.tika.parser.txt

Methods in org.apache.tika.parser.txt with annotations of type Field

Modifier and Type	Method	Description
void	Icu4jEncodingDetector.setIgnoreCharsets(List<String> charsetsToIgnore)
void	Icu4jEncodingDetector.setMarkLimit(int markLimit)	How far into the stream to read for charset detection.
void	UniversalEncodingDetector.setMarkLimit(int markLimit)	How far into the stream to read for charset detection.
void	Icu4jEncodingDetector.setStripMarkup(boolean stripMarkup)	Whether or not to attempt to strip html-ish markup from the stream before sending it to the underlying detector.

Uses of Field in org.apache.tika.parser.wordperfect

Methods in org.apache.tika.parser.wordperfect with annotations of type Field

Modifier and Type	Method	Description
void	WordPerfectParser.setIncludeDeletedContent(boolean includeDeletedContent)	Whether or not to include deleted content.

Uses of Field in org.apache.tika.pipes

Methods in org.apache.tika.pipes with annotations of type Field

Modifier and Type	Method	Description
void	CompositePipesReporter.addPipesReporter(PipesReporter pipesReporter)
void	PipesReporterBase.setExcludes(List<String> excludes)
void	PipesReporterBase.setIncludes(List<String> includes)

Uses of Field in org.apache.tika.pipes.emitter.azblob

Methods in org.apache.tika.pipes.emitter.azblob with annotations of type Field

Modifier and Type	Method	Description
void	AZBlobEmitter.setContainer(String container)
void	AZBlobEmitter.setEndpoint(String endpoint)
void	AZBlobEmitter.setFileExtension(String fileExtension)	If you want to customize the output file's file extension.
void	AZBlobEmitter.setOverwriteExisting(boolean overwriteExisting)
void	AZBlobEmitter.setPrefix(String prefix)
void	AZBlobEmitter.setSasToken(String sasToken)

Uses of Field in org.apache.tika.pipes.emitter.fs

Methods in org.apache.tika.pipes.emitter.fs with annotations of type Field

Modifier and Type	Method	Description
void	FileSystemEmitter.setBasePath(String basePath)
void	FileSystemEmitter.setFileExtension(String fileExtension)	If you want to customize the output file's file extension.
void	FileSystemEmitter.setOnExists(String onExists)	What to do if the target file already exists.
void	FileSystemEmitter.setPrettyPrint(boolean prettyPrint)

Uses of Field in org.apache.tika.pipes.emitter.gcs

Methods in org.apache.tika.pipes.emitter.gcs with annotations of type Field

Modifier and Type	Method	Description
void	GCSEmitter.setBucket(String bucket)
void	GCSEmitter.setFileExtension(String fileExtension)	If you want to customize the output file's file extension.
void	GCSEmitter.setPrefix(String prefix)
void	GCSEmitter.setProjectId(String projectId)

Uses of Field in org.apache.tika.pipes.emitter.jdbc

Methods in org.apache.tika.pipes.emitter.jdbc with annotations of type Field

Modifier and Type	Method	Description
void	JDBCEmitter.setAttachmentStrategy(String attachmentStrategy)
void	JDBCEmitter.setConnection(String connection)
void	JDBCEmitter.setCreateTable(String createTable)
void	JDBCEmitter.setInsert(String insert)
void	JDBCEmitter.setKeys(Map<String,String> keys)	The implementation of keys should be a LinkedHashMap because order matters!
void	JDBCEmitter.setMaxStringLength(int maxStringLength)	Set the maximum string length in characters (not bytes).
void	JDBCEmitter.setMultivaluedFieldDelimiter(String delimiter)	See JDBCEmitter.setMultivaluedFieldDelimiter(String)
void	JDBCEmitter.setMultivaluedFieldStrategy(String strategy)	This applies to fields of type 'string' or 'varchar'.
void	JDBCEmitter.setPostConnection(String postConnection)	This sql will be called immediately after the connection is made.

Uses of Field in org.apache.tika.pipes.emitter.kafka

Methods in org.apache.tika.pipes.emitter.kafka with annotations of type Field

Modifier and Type	Method	Description
void	KafkaEmitter.setAcks(String acks)
void	KafkaEmitter.setBootstrapServers(String bootstrapServers)
void	KafkaEmitter.setBufferMemory(int bufferMemory)
void	KafkaEmitter.setClientId(String clientId)
void	KafkaEmitter.setCompressionType(String compressionType)
void	KafkaEmitter.setConnectionsMaxIdleMs(int connectionsMaxIdleMs)
void	KafkaEmitter.setDeliveryTimeoutMs(int deliveryTimeoutMs)
void	KafkaEmitter.setEnableIdempotence(boolean enableIdempotence)
void	KafkaEmitter.setInterceptorClasses(String interceptorClasses)
void	KafkaEmitter.setKeySerializer(String keySerializer)
void	KafkaEmitter.setLingerMs(int lingerMs)
void	KafkaEmitter.setMaxBlockMs(int maxBlockMs)
void	KafkaEmitter.setMaxInFlightRequestsPerConnection(int maxInFlightRequestsPerConnection)
void	KafkaEmitter.setMaxRequestSize(int maxRequestSize)
void	KafkaEmitter.setMetadataMaxAgeMs(int metadataMaxAgeMs)
void	KafkaEmitter.setRequestTimeoutMs(int requestTimeoutMs)
void	KafkaEmitter.setRetries(int retries)
void	KafkaEmitter.setRetryBackoffMs(int retryBackoffMs)
void	KafkaEmitter.setTopic(String topic)
void	KafkaEmitter.setTransactionalId(String transactionalId)
void	KafkaEmitter.setTransactionTimeoutMs(int transactionTimeoutMs)
void	KafkaEmitter.setValueSerializer(String valueSerializer)

Uses of Field in org.apache.tika.pipes.emitter.opensearch

Methods in org.apache.tika.pipes.emitter.opensearch with annotations of type Field

Modifier and Type	Method	Description
void	OpenSearchEmitter.setAttachmentStrategy(String attachmentStrategy)	Options: SEPARATE_DOCUMENTS, PARENT_CHILD.
void	OpenSearchEmitter.setAuthScheme(String authScheme)
void	OpenSearchEmitter.setCommitWithin(int commitWithin)
void	OpenSearchEmitter.setConnectionTimeout(int connectionTimeout)
void	OpenSearchEmitter.setEmbeddedFileFieldName(String embeddedFileFieldName)	If using the OpenSearchEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents.
void	OpenSearchEmitter.setIdField(String idField)	Specify the field in the first Metadata that should be used as the id field for the document.
void	OpenSearchEmitter.setOpenSearchUrl(String openSearchUrl)
void	OpenSearchEmitter.setPassword(String password)
void	OpenSearchEmitter.setProxyHost(String proxyHost)
void	OpenSearchEmitter.setProxyPort(int proxyPort)
void	OpenSearchEmitter.setSocketTimeout(int socketTimeout)
void	OpenSearchEmitter.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.emitter.s3

Methods in org.apache.tika.pipes.emitter.s3 with annotations of type Field

Modifier and Type	Method	Description
void	S3Emitter.setAccessKey(String accessKey)
void	S3Emitter.setBucket(String bucket)
void	S3Emitter.setCredentialsProvider(String credentialsProvider)
void	S3Emitter.setEndpointConfigurationService(String endpointConfigurationService)
void	S3Emitter.setFileExtension(String fileExtension)	If you want to customize the output file's file extension.
void	S3Emitter.setMaxConnections(int maxConnections)	maximum number of http connections allowed.
void	S3Emitter.setPathStyleAccessEnabled(boolean pathStyleAccessEnabled)
void	S3Emitter.setPrefix(String prefix)
void	S3Emitter.setProfile(String profile)
void	S3Emitter.setRegion(String region)
void	S3Emitter.setSecretKey(String secretKey)
void	S3Emitter.setSpoolToTemp(boolean spoolToTemp)	Whether or not to spool the metadatalist to a tmp file before putting object.

Uses of Field in org.apache.tika.pipes.emitter.solr

Methods in org.apache.tika.pipes.emitter.solr with annotations of type Field

Modifier and Type	Method	Description
void	SolrEmitter.setAttachmentStrategy(String attachmentStrategy)	Options: SKIP, CONCATENATE_CONTENT, PARENT_CHILD.
void	SolrEmitter.setAuthScheme(String authScheme)
void	SolrEmitter.setCommitWithin(int commitWithin)
void	SolrEmitter.setConnectionTimeout(int connectionTimeout)
void	SolrEmitter.setEmbeddedFileFieldName(String embeddedFileFieldName)	If using the SolrEmitter.AttachmentStrategy.PARENT_CHILD, this is the field name used to store the child documents.
void	SolrEmitter.setIdField(String idField)	Specify the field in the first Metadata that should be used as the id field for the document.
void	SolrEmitter.setPassword(String password)
void	SolrEmitter.setProxyHost(String proxyHost)
void	SolrEmitter.setProxyPort(int proxyPort)
void	SolrEmitter.setSocketTimeout(int socketTimeout)
void	SolrEmitter.setSolrCollection(String solrCollection)
void	SolrEmitter.setSolrUrls(List<String> solrUrls)
void	SolrEmitter.setSolrZkChroot(String solrZkChroot)
void	SolrEmitter.setSolrZkHosts(List<String> solrZkHosts)
void	SolrEmitter.setUpdateStrategy(String updateStrategy)
void	SolrEmitter.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.fetcher

Methods in org.apache.tika.pipes.fetcher with annotations of type Field

Modifier and Type	Method	Description
void	AbstractFetcher.setName(String name)

Uses of Field in org.apache.tika.pipes.fetcher.azblob

Methods in org.apache.tika.pipes.fetcher.azblob with annotations of type Field

Modifier and Type	Method	Description
void	AZBlobFetcher.setContainer(String container)
void	AZBlobFetcher.setEndpoint(String endpoint)
void	AZBlobFetcher.setExtractUserMetadata(boolean extractUserMetadata)	Whether or not to extract user metadata from the blob object
void	AZBlobFetcher.setSasToken(String sasToken)
void	AZBlobFetcher.setSpoolToTemp(boolean spoolToTemp)

Uses of Field in org.apache.tika.pipes.fetcher.fs

Methods in org.apache.tika.pipes.fetcher.fs with annotations of type Field

Modifier and Type	Method	Description
void	FileSystemFetcher.setBasePath(String basePath)	Default behavior si that clients will send in relative paths, this must be set to allow this fetcher to fetch the full path.
void	FileSystemFetcher.setExtractFileSystemMetadata(boolean extractFileSystemMetadata)	Extract file system metadata (created, modified, accessed) when fetching file.

Uses of Field in org.apache.tika.pipes.fetcher.gcs

Methods in org.apache.tika.pipes.fetcher.gcs with annotations of type Field

Modifier and Type	Method	Description
void	GCSFetcher.setBucket(String bucket)
void	GCSFetcher.setExtractUserMetadata(boolean extractUserMetadata)	Whether or not to extract user metadata from the S3Object
void	GCSFetcher.setProjectId(String projectId)
void	GCSFetcher.setSpoolToTemp(boolean spoolToTemp)

Uses of Field in org.apache.tika.pipes.fetcher.http

Methods in org.apache.tika.pipes.fetcher.http with annotations of type Field

Modifier and Type	Method	Description
void	HttpFetcher.setAuthScheme(String authScheme)
void	HttpFetcher.setConnectTimeout(int connectTimeout)
void	HttpFetcher.setHttpHeaders(List<String> headers)	Which http headers should we capture in the metadata.
void	HttpFetcher.setHttpRequestHeaders(List<String> headers)	Which http request headers should we send in the http fetch requests.
void	HttpFetcher.setJwtExpiresInSeconds(int jwtExpiresInSeconds)
void	HttpFetcher.setJwtIssuer(String jwtIssuer)
void	HttpFetcher.setJwtPrivateKeyBase64(String jwtPrivateKeyBase64)
void	HttpFetcher.setJwtSecret(String jwtSecret)
void	HttpFetcher.setJwtSubject(String jwtSubject)
void	HttpFetcher.setMaxConnections(int maxConnections)
void	HttpFetcher.setMaxConnectionsPerRoute(int maxConnectionsPerRoute)
void	HttpFetcher.setMaxErrMsgSize(int maxErrMsgSize)
void	HttpFetcher.setMaxRedirects(int maxRedirects)
void	HttpFetcher.setMaxSpoolSize(long maxSpoolSize)	Set the maximum number of bytes to spool to a temp file.
void	HttpFetcher.setNtDomain(String domain)
void	HttpFetcher.setOverallTimeout(long overallTimeout)	This sets an overall timeout on the request.
void	HttpFetcher.setPassword(String password)
void	HttpFetcher.setProxyHost(String proxyHost)
void	HttpFetcher.setProxyPort(int proxyPort)
void	HttpFetcher.setRequestTimeout(int requestTimeout)
void	HttpFetcher.setSocketTimeout(int socketTimeout)
void	HttpFetcher.setUserAgent(String userAgent)	When making the request, what User-Agent is sent in the request.
void	HttpFetcher.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.fetcher.s3

Methods in org.apache.tika.pipes.fetcher.s3 with annotations of type Field

Modifier and Type	Method	Description
void	S3Fetcher.setAccessKey(String accessKey)
void	S3Fetcher.setBucket(String bucket)
void	S3Fetcher.setCredentialsProvider(String credentialsProvider)
void	S3Fetcher.setEndpointConfigurationService(String endpointConfigurationService)
void	S3Fetcher.setExtractUserMetadata(boolean extractUserMetadata)	Whether or not to extract user metadata from the S3Object
void	S3Fetcher.setMaxConnections(int maxConnections)
void	S3Fetcher.setMaxLength(long maxLength)
void	S3Fetcher.setPathStyleAccessEnabled(boolean pathStyleAccessEnabled)
void	S3Fetcher.setPrefix(String prefix)	prefix to prepend to the fetch key before fetching.
void	S3Fetcher.setProfile(String profile)
void	S3Fetcher.setRegion(String region)
void	S3Fetcher.setSecretKey(String secretKey)
void	S3Fetcher.setSleepBeforeRetryMillis(long sleepBeforeRetryMillis)	Deprecated. use S3Fetcher.setThrottleSeconds(String)
void	S3Fetcher.setSpoolToTemp(boolean spoolToTemp)
void	S3Fetcher.setThrottleSeconds(String commaDelimitedLongs)	Set seconds to throttle retries as a comma-delimited list, e.g.: 30,60,120,600

Uses of Field in org.apache.tika.pipes.fetchers.microsoftgraph

Methods in org.apache.tika.pipes.fetchers.microsoftgraph with annotations of type Field

Modifier and Type	Method	Description
void	MicrosoftGraphFetcher.setThrottleSeconds(String commaDelimitedLongs)	Set seconds to throttle retries as a comma-delimited list, e.g.: 30,60,120,600

Uses of Field in org.apache.tika.pipes.pipesiterator

Methods in org.apache.tika.pipes.pipesiterator with annotations of type Field

Modifier and Type	Method	Description
void	PipesIterator.setEmitterName(String emitterName)
void	PipesIterator.setFetcherName(String fetcherName)
void	PipesIterator.setHandlerType(String handlerType)
void	PipesIterator.setMaxEmbeddedResources(int maxEmbeddedResources)
void	PipesIterator.setMaxWaitMs(long maxWaitMs)
void	PipesIterator.setOnParseException(String onParseException)
void	PipesIterator.setParseMode(String parseModeString)
void	PipesIterator.setQueueSize(int queueSize)
void	PipesIterator.setThrowOnWriteLimitReached(boolean throwOnWriteLimitReached)
void	PipesIterator.setWriteLimit(int writeLimit)

Uses of Field in org.apache.tika.pipes.pipesiterator.azblob

Methods in org.apache.tika.pipes.pipesiterator.azblob with annotations of type Field

Modifier and Type	Method	Description
void	AZBlobPipesIterator.setContainer(String container)
void	AZBlobPipesIterator.setEndpoint(String endpoint)
void	AZBlobPipesIterator.setPrefix(String prefix)
void	AZBlobPipesIterator.setSasToken(String sasToken)

Uses of Field in org.apache.tika.pipes.pipesiterator.csv

Methods in org.apache.tika.pipes.pipesiterator.csv with annotations of type Field

Modifier and Type	Method	Description
void	CSVPipesIterator.setCsvPath(String csvPath)
void	CSVPipesIterator.setCsvPath(Path csvPath)
void	CSVPipesIterator.setEmitKeyColumn(String emitKeyColumn)
void	CSVPipesIterator.setFetchKeyColumn(String fetchKeyColumn)
void	CSVPipesIterator.setIdColumn(String idColumn)

Uses of Field in org.apache.tika.pipes.pipesiterator.filelist

Methods in org.apache.tika.pipes.pipesiterator.filelist with annotations of type Field

Modifier and Type	Method	Description
void	FileListPipesIterator.setFileList(String path)
void	FileListPipesIterator.setHasHeader(boolean hasHeader)

Uses of Field in org.apache.tika.pipes.pipesiterator.fs

Methods in org.apache.tika.pipes.pipesiterator.fs with annotations of type Field

Modifier and Type	Method	Description
void	FileSystemPipesIterator.setBasePath(String basePath)
void	FileSystemPipesIterator.setCountTotal(boolean countTotal)

Uses of Field in org.apache.tika.pipes.pipesiterator.gcs

Methods in org.apache.tika.pipes.pipesiterator.gcs with annotations of type Field

Modifier and Type	Method	Description
void	GCSPipesIterator.setBucket(String bucket)
void	GCSPipesIterator.setPrefix(String prefix)
void	GCSPipesIterator.setProjectId(String projectId)

Uses of Field in org.apache.tika.pipes.pipesiterator.jdbc

Methods in org.apache.tika.pipes.pipesiterator.jdbc with annotations of type Field

Modifier and Type	Method	Description
void	JDBCPipesIterator.setConnection(String connection)
void	JDBCPipesIterator.setEmitKeyColumn(String fetchKeyColumn)
void	JDBCPipesIterator.setFetchKeyColumn(String fetchKeyColumn)
void	JDBCPipesIterator.setFetchKeyRangeEndColumn(String fetchKeyRangeEndColumn)
void	JDBCPipesIterator.setFetchKeyRangeStartColumn(String fetchKeyRangeStartColumn)
void	JDBCPipesIterator.setFetchSize(int fetchSize)
void	JDBCPipesIterator.setIdColumn(String idColumn)
void	JDBCPipesIterator.setSelect(String select)

Uses of Field in org.apache.tika.pipes.pipesiterator.kafka

Methods in org.apache.tika.pipes.pipesiterator.kafka with annotations of type Field

Modifier and Type	Method	Description
void	KafkaPipesIterator.setAutoOffsetReset(String autoOffsetReset)
void	KafkaPipesIterator.setBootstrapServers(String bootstrapServers)
void	KafkaPipesIterator.setEmitMax(int emitMax)	If the kafka pipe iterator will keep polling for more documents until it returns an empty result.
void	KafkaPipesIterator.setGroupId(String groupId)
void	KafkaPipesIterator.setGroupInitialRebalanceDelayMs(int groupInitialRebalanceDelayMs)
void	KafkaPipesIterator.setKeySerializer(String keySerializer)
void	KafkaPipesIterator.setPollDelayMs(int pollDelayMs)
void	KafkaPipesIterator.setTopic(String topic)
void	KafkaPipesIterator.setValueSerializer(String valueSerializer)

Uses of Field in org.apache.tika.pipes.pipesiterator.s3

Methods in org.apache.tika.pipes.pipesiterator.s3 with annotations of type Field

Modifier and Type	Method	Description
void	S3PipesIterator.setAccessKey(String accessKey)
void	S3PipesIterator.setBucket(String bucket)
void	S3PipesIterator.setCredentialsProvider(String credentialsProvider)
void	S3PipesIterator.setEndpointConfigurationService(String endpointConfigurationService)
void	S3PipesIterator.setFileNamePattern(String fileNamePattern)
void	S3PipesIterator.setFileNamePattern(Pattern fileNamePattern)
void	S3PipesIterator.setMaxConnections(int maxConnections)
void	S3PipesIterator.setPathStyleAccessEnabled(boolean pathStyleAccessEnabled)
void	S3PipesIterator.setPrefix(String prefix)
void	S3PipesIterator.setProfile(String profile)
void	S3PipesIterator.setRegion(String region)
void	S3PipesIterator.setSecretKey(String secretKey)

Uses of Field in org.apache.tika.pipes.pipesiterator.solr

Methods in org.apache.tika.pipes.pipesiterator.solr with annotations of type Field

Modifier and Type	Method	Description
void	SolrPipesIterator.setAdditionalFields(List<String> additionalFields)
void	SolrPipesIterator.setAuthScheme(String authScheme)
void	SolrPipesIterator.setConnectionTimeout(int connectionTimeout)
void	SolrPipesIterator.setFailCountField(String failCountField)
void	SolrPipesIterator.setFilters(List<String> filters)
void	SolrPipesIterator.setIdField(String idField)
void	SolrPipesIterator.setParsingIdField(String parsingIdField)
void	SolrPipesIterator.setPassword(String password)
void	SolrPipesIterator.setProxyHost(String proxyHost)
void	SolrPipesIterator.setProxyPort(int proxyPort)
void	SolrPipesIterator.setRows(int rows)
void	SolrPipesIterator.setSizeFieldName(String sizeFieldName)
void	SolrPipesIterator.setSocketTimeout(int socketTimeout)
void	SolrPipesIterator.setSolrCollection(String solrCollection)
void	SolrPipesIterator.setSolrUrls(List<String> solrUrls)
void	SolrPipesIterator.setSolrZkChroot(String solrZkChroot)
void	SolrPipesIterator.setSolrZkHosts(List<String> solrZkHosts)
void	SolrPipesIterator.setUserName(String userName)

Uses of Field in org.apache.tika.pipes.reporters.fs

Methods in org.apache.tika.pipes.reporters.fs with annotations of type Field

Modifier and Type	Method	Description
void	FileSystemStatusReporter.setReportUpdateMillis(long millis)
void	FileSystemStatusReporter.setStatusFile(String path)

Uses of Field in org.apache.tika.pipes.reporters.jdbc

Methods in org.apache.tika.pipes.reporters.jdbc with annotations of type Field

Modifier and Type	Method	Description
void	JDBCPipesReporter.setCacheSize(int cacheSize)	Commit the reports if the cache is greater than or equal to this size.
void	JDBCPipesReporter.setConnection(String connection)
void	JDBCPipesReporter.setCreateTable(boolean createTable)	The default is true.
void	JDBCPipesReporter.setPostConnection(String postConnection)	This sql will be called immediately after the connection is made.
void	JDBCPipesReporter.setReportSql(String reportSql)	This is the sql for the prepared statement to execute to store the report record. the default is: insert into tika_status (id, status, timestamp) values (?

Uses of Field in org.apache.tika.pipes.reporters.opensearch

Methods in org.apache.tika.pipes.reporters.opensearch with annotations of type Field

Modifier and Type	Method	Description
void	OpenSearchPipesReporter.setAuthScheme(String authScheme)
void	OpenSearchPipesReporter.setConnectionTimeout(int connectionTimeout)
void	OpenSearchPipesReporter.setExcludeStatuses(List<String> statusList)
void	OpenSearchPipesReporter.setIncludeRouting(boolean includeRouting)
void	OpenSearchPipesReporter.setIncludeStatuses(List<String> statusList)
void	OpenSearchPipesReporter.setKeyPrefix(String keyPrefix)	This prefixes the keys before sending them to OpenSearch.
void	OpenSearchPipesReporter.setOpenSearchUrl(String openSearchUrl)
void	OpenSearchPipesReporter.setPassword(String password)
void	OpenSearchPipesReporter.setProxyHost(String proxyHost)
void	OpenSearchPipesReporter.setProxyPort(int proxyPort)
void	OpenSearchPipesReporter.setSocketTimeout(int socketTimeout)
void	OpenSearchPipesReporter.setUserName(String userName)