Serialized Form

Package org.apache.pinot.spi.config

Class org.apache.pinot.spi.config.BaseJsonConfig extends Object implements Serializable

Class org.apache.pinot.spi.config.TableConfigs extends BaseJsonConfig implements Serializable

Serialized Fields

_offline

TableConfig _offline

_realtime

TableConfig _realtime

_schema

Schema _schema

_tableName

String _tableName

Package org.apache.pinot.spi.config.instance

Class org.apache.pinot.spi.config.instance.Instance extends BaseJsonConfig implements Serializable

Serialized Fields

_adminPort

int _adminPort

_grpcPort

int _grpcPort

_host

String _host

_pools

Map<String,Integer> _pools

_port

int _port

_queriesDisabled

boolean _queriesDisabled

_queryMailboxPort

int _queryMailboxPort

_queryServicePort

int _queryServicePort

_tags

List<String> _tags

_type

InstanceType _type

Package org.apache.pinot.spi.config.table

Class org.apache.pinot.spi.config.table.BloomFilterConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_fpp

double _fpp

_loadOnHeap

boolean _loadOnHeap

_maxSizeInBytes

int _maxSizeInBytes

Class org.apache.pinot.spi.config.table.ColumnPartitionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_functionConfig

Map<String,String> _functionConfig

_functionName

String _functionName

_numPartitions

int _numPartitions

Class org.apache.pinot.spi.config.table.CompletionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_completionMode

String _completionMode

Class org.apache.pinot.spi.config.table.DedupConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_dedupEnabled

boolean _dedupEnabled

_hashFunction

HashFunction _hashFunction

Class org.apache.pinot.spi.config.table.DimensionTableConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_disablePreload

boolean _disablePreload

Class org.apache.pinot.spi.config.table.FieldConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_compressionCodec

FieldConfig.CompressionCodec _compressionCodec

_encodingType

FieldConfig.EncodingType _encodingType

_indexTypes

List<FieldConfig.IndexType> _indexTypes

_name

String _name

_properties

Map<String,String> _properties

_timestampConfig

TimestampConfig _timestampConfig

Class org.apache.pinot.spi.config.table.IndexingConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_aggregateMetrics

boolean _aggregateMetrics

_autoGeneratedInvertedIndex

boolean _autoGeneratedInvertedIndex

_bloomFilterColumns

List<String> _bloomFilterColumns

_bloomFilterConfigs

Map<String,BloomFilterConfig> _bloomFilterConfigs

_columnMinMaxValueGeneratorMode

String _columnMinMaxValueGeneratorMode

_createInvertedIndexDuringSegmentGeneration

boolean _createInvertedIndexDuringSegmentGeneration

_enableDefaultStarTree

boolean _enableDefaultStarTree

_enableDynamicStarTreeCreation

boolean _enableDynamicStarTreeCreation

_fstTypeForFSTIndex

FSTType _fstTypeForFSTIndex

_h3IndexColumns

List<String> _h3IndexColumns

_invertedIndexColumns

List<String> _invertedIndexColumns

_jsonIndexColumns

List<String> _jsonIndexColumns

Deprecated.

_jsonIndexConfigs

Map<String,JsonIndexConfig> _jsonIndexConfigs

_loadMode

String _loadMode

_noDictionaryColumns

List<String> _noDictionaryColumns

_noDictionaryConfig

Map<String,String> _noDictionaryConfig

_noDictionarySizeRatioThreshold

double _noDictionarySizeRatioThreshold

_nullHandlingEnabled

boolean _nullHandlingEnabled

_onHeapDictionaryColumns

List<String> _onHeapDictionaryColumns

_optimizeDictionary

boolean _optimizeDictionary

If `optimizeDictionary` enabled, dictionary is not created for the high-cardinality single-valued columns for which rawIndexSize / forwardIndexSize is less than the `noDictionarySizeRatioThreshold`. It also disables dictionary for json and text columns.

_optimizeDictionaryForMetrics

boolean _optimizeDictionaryForMetrics

Same as `optimizeDictionary` but only for metric columns.

_rangeIndexColumns

List<String> _rangeIndexColumns

_rangeIndexVersion

int _rangeIndexVersion

_segmentFormatVersion

String _segmentFormatVersion

_segmentNameGeneratorType

String _segmentNameGeneratorType

_segmentPartitionConfig

SegmentPartitionConfig _segmentPartitionConfig

_sortedColumn

List<String> _sortedColumn

_starTreeIndexConfigs

List<StarTreeIndexConfig> _starTreeIndexConfigs

_streamConfigs

Map<String,String> _streamConfigs

Deprecated.

_varLengthDictionaryColumns

List<String> _varLengthDictionaryColumns

The list of columns for which the variable length dictionary needs to be enabled in offline segments. This is only valid for string and bytes columns and has no impact for columns of other data types.

Class org.apache.pinot.spi.config.table.JsonIndexConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_disableCrossArrayUnnest

boolean _disableCrossArrayUnnest

_excludeArray

boolean _excludeArray

_excludeFields

Set<String> _excludeFields

_excludePaths

Set<String> _excludePaths

_includePaths

Set<String> _includePaths

_maxLevels

int _maxLevels

Class org.apache.pinot.spi.config.table.QueryConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_disableGroovy

Boolean _disableGroovy

_expressionOverrideMap

Map<String,String> _expressionOverrideMap

_timeoutMs

Long _timeoutMs

_useApproximateFunction

Boolean _useApproximateFunction

Class org.apache.pinot.spi.config.table.QuotaConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_maxQueriesPerSecond

String _maxQueriesPerSecond

_storage

String _storage

Class org.apache.pinot.spi.config.table.ReplicaGroupStrategyConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_numInstancesPerPartition

int _numInstancesPerPartition

_partitionColumn

String _partitionColumn

Class org.apache.pinot.spi.config.table.RoutingConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_instanceSelectorType

String _instanceSelectorType

_routingTableBuilderName

String _routingTableBuilderName

Deprecated.

_segmentPrunerTypes

List<String> _segmentPrunerTypes

Class org.apache.pinot.spi.config.table.SegmentPartitionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_columnPartitionMap

Map<String,ColumnPartitionConfig> _columnPartitionMap

Class org.apache.pinot.spi.config.table.SegmentsValidationAndRetentionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_completionConfig

CompletionConfig _completionConfig

_crypterClassName

String _crypterClassName

_deletedSegmentsRetentionPeriod

String _deletedSegmentsRetentionPeriod

_minimizeDataMovement

boolean _minimizeDataMovement

_peerSegmentDownloadScheme

String _peerSegmentDownloadScheme

_replicaGroupStrategyConfig

ReplicaGroupStrategyConfig _replicaGroupStrategyConfig

_replicasPerPartition

String _replicasPerPartition

_replication

String _replication

_retentionTimeUnit

String _retentionTimeUnit

_retentionTimeValue

String _retentionTimeValue

_schemaName

String _schemaName

_segmentAssignmentStrategy

String _segmentAssignmentStrategy

_segmentPushFrequency

String _segmentPushFrequency

Deprecated.

_segmentPushType

String _segmentPushType

Deprecated.

_timeColumnName

String _timeColumnName

_timeType

TimeUnit _timeType

Class org.apache.pinot.spi.config.table.StarTreeIndexConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_dimensionsSplitOrder

List<String> _dimensionsSplitOrder

_functionColumnPairs

List<String> _functionColumnPairs

_maxLeafRecords

int _maxLeafRecords

_skipStarNodeCreationForDimensions

List<String> _skipStarNodeCreationForDimensions

Class org.apache.pinot.spi.config.table.TableConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_customConfig

TableCustomConfig _customConfig

_dedupConfig

DedupConfig _dedupConfig

_dimensionTableConfig

DimensionTableConfig _dimensionTableConfig

_dimTable

boolean _dimTable

_fieldConfigList

List<FieldConfig> _fieldConfigList

_indexingConfig

IndexingConfig _indexingConfig

_ingestionConfig

IngestionConfig _ingestionConfig

_instanceAssignmentConfigMap

Map<InstancePartitionsType,InstanceAssignmentConfig> _instanceAssignmentConfigMap

_instancePartitionsMap

Map<InstancePartitionsType,String> _instancePartitionsMap

_queryConfig

QueryConfig _queryConfig

_quotaConfig

QuotaConfig _quotaConfig

_routingConfig

RoutingConfig _routingConfig

_segmentAssignmentConfigMap

Map<String,SegmentAssignmentConfig> _segmentAssignmentConfigMap

_tableName

String _tableName

_tableType

TableType _tableType

_taskConfig

TableTaskConfig _taskConfig

_tenantConfig

TenantConfig _tenantConfig

_tierConfigsList

List<TierConfig> _tierConfigsList

_tunerConfigList

List<TunerConfig> _tunerConfigList

_upsertConfig

UpsertConfig _upsertConfig

_validationConfig

SegmentsValidationAndRetentionConfig _validationConfig

Class org.apache.pinot.spi.config.table.TableCustomConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_customConfigs

Map<String,String> _customConfigs

Class org.apache.pinot.spi.config.table.TableTaskConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_taskTypeConfigsMap

Map<String,Map<String,String>> _taskTypeConfigsMap

Class org.apache.pinot.spi.config.table.TagOverrideConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_realtimeCompleted

String _realtimeCompleted

_realtimeConsuming

String _realtimeConsuming

Class org.apache.pinot.spi.config.table.TenantConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_broker

String _broker

_server

String _server

_tagOverrideConfig

TagOverrideConfig _tagOverrideConfig

Class org.apache.pinot.spi.config.table.TierConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_name

String _name

_segmentAge

String _segmentAge

_segmentList

List<String> _segmentList

_segmentSelectorType

String _segmentSelectorType

_serverTag

String _serverTag

_storageType

String _storageType

_tierBackend

String _tierBackend

_tierBackendProperties

Map<String,String> _tierBackendProperties

Class org.apache.pinot.spi.config.table.TimestampConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_granularities

List<TimestampIndexGranularity> _granularities

Class org.apache.pinot.spi.config.table.TunerConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_name

String _name

_tunerProperties

Map<String,String> _tunerProperties

Class org.apache.pinot.spi.config.table.UpsertConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_comparisonColumn

String _comparisonColumn

_defaultPartialUpsertStrategy

UpsertConfig.Strategy _defaultPartialUpsertStrategy

_enableSnapshot

boolean _enableSnapshot

_hashFunction

HashFunction _hashFunction

_metadataManagerClass

String _metadataManagerClass

_metadataManagerConfigs

Map<String,String> _metadataManagerConfigs

_mode

UpsertConfig.Mode _mode

_partialUpsertStrategies

Map<String,UpsertConfig.Strategy> _partialUpsertStrategies

Package org.apache.pinot.spi.config.table.assignment

Class org.apache.pinot.spi.config.table.assignment.InstanceAssignmentConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_constraintConfig

InstanceConstraintConfig _constraintConfig

_partitionSelector

InstanceAssignmentConfig.PartitionSelector _partitionSelector

_replicaGroupPartitionConfig

InstanceReplicaGroupPartitionConfig _replicaGroupPartitionConfig

_tagPoolConfig

InstanceTagPoolConfig _tagPoolConfig

Class org.apache.pinot.spi.config.table.assignment.InstanceConstraintConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_constraints

List<String> _constraints

Class org.apache.pinot.spi.config.table.assignment.InstanceReplicaGroupPartitionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_minimizeDataMovement

boolean _minimizeDataMovement

_numInstances

int _numInstances

_numInstancesPerPartition

int _numInstancesPerPartition

_numInstancesPerReplicaGroup

int _numInstancesPerReplicaGroup

_numPartitions

int _numPartitions

_numReplicaGroups

int _numReplicaGroups

_replicaGroupBased

boolean _replicaGroupBased

Class org.apache.pinot.spi.config.table.assignment.InstanceTagPoolConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_numPools

int _numPools

_poolBased

boolean _poolBased

_pools

List<Integer> _pools

_tag

String _tag

Class org.apache.pinot.spi.config.table.assignment.SegmentAssignmentConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_assignmentStrategy

String _assignmentStrategy

Package org.apache.pinot.spi.config.table.ingestion

Class org.apache.pinot.spi.config.table.ingestion.AggregationConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_aggregationFunction

String _aggregationFunction

_columnName

String _columnName

Class org.apache.pinot.spi.config.table.ingestion.BatchIngestionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_batchConfigMaps

List<Map<String,String>> _batchConfigMaps

_consistentDataPush

boolean _consistentDataPush

_segmentIngestionFrequency

String _segmentIngestionFrequency

_segmentIngestionType

String _segmentIngestionType

Class org.apache.pinot.spi.config.table.ingestion.ComplexTypeConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_collectionNotUnnestedToJson

ComplexTypeConfig.CollectionNotUnnestedToJson _collectionNotUnnestedToJson

_delimiter

String _delimiter

_fieldsToUnnest

List<String> _fieldsToUnnest

_prefixesToRename

Map<String,String> _prefixesToRename

Class org.apache.pinot.spi.config.table.ingestion.FilterConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_filterFunction

String _filterFunction

Class org.apache.pinot.spi.config.table.ingestion.IngestionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_aggregationConfigs

List<AggregationConfig> _aggregationConfigs

_batchIngestionConfig

BatchIngestionConfig _batchIngestionConfig

_complexTypeConfig

ComplexTypeConfig _complexTypeConfig

_continueOnError

boolean _continueOnError

_filterConfig

FilterConfig _filterConfig

_rowTimeValueCheck

boolean _rowTimeValueCheck

_segmentTimeValueCheck

boolean _segmentTimeValueCheck

_streamIngestionConfig

StreamIngestionConfig _streamIngestionConfig

_transformConfigs

List<TransformConfig> _transformConfigs

Class org.apache.pinot.spi.config.table.ingestion.StreamIngestionConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_streamConfigMaps

List<Map<String,String>> _streamConfigMaps

Class org.apache.pinot.spi.config.table.ingestion.TransformConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_columnName

String _columnName

_transformFunction

String _transformFunction

Package org.apache.pinot.spi.config.task

Class org.apache.pinot.spi.config.task.AdhocTaskConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_tableName

String _tableName

_taskConfigs

Map<String,String> _taskConfigs

_taskName

String _taskName

_taskType

String _taskType

Package org.apache.pinot.spi.config.tenant

Class org.apache.pinot.spi.config.tenant.Tenant extends BaseJsonConfig implements Serializable

Serialized Fields

_numberOfInstances

int _numberOfInstances

_offlineInstances

int _offlineInstances

_realtimeInstances

int _realtimeInstances

_tenantName

String _tenantName

_tenantRole

TenantRole _tenantRole

Package org.apache.pinot.spi.config.user

Class org.apache.pinot.spi.config.user.UserConfig extends BaseJsonConfig implements Serializable

Serialized Fields

_componentType

ComponentType _componentType

_password

String _password

_permissions

List<AccessType> _permissions

_roleType

RoleType _roleType

_tables

List<String> _tables

_username

String _username

Package org.apache.pinot.spi.data

Class org.apache.pinot.spi.data.ComplexFieldSpec extends FieldSpec implements Serializable

Serialized Fields

_childFieldSpecs

Map<String,FieldSpec> _childFieldSpecs

Class org.apache.pinot.spi.data.DateTimeFieldSpec extends FieldSpec implements Serializable

Serialized Fields

_format

String _format

_granularity

String _granularity

_sampleValue

Object _sampleValue

Class org.apache.pinot.spi.data.DimensionFieldSpec extends FieldSpec implements Serializable

Class org.apache.pinot.spi.data.FieldSpec extends Object implements Serializable

Serialized Fields

_dataType

FieldSpec.DataType _dataType

_defaultNullValue

Object _defaultNullValue

_isSingleValueField

boolean _isSingleValueField

_maxLength

int _maxLength

_name

String _name

_transformFunction

String _transformFunction

Deprecated.

_virtualColumnProvider

String _virtualColumnProvider

Class org.apache.pinot.spi.data.MetricFieldSpec extends FieldSpec implements Serializable

Class org.apache.pinot.spi.data.Schema extends Object implements Serializable

Serialized Fields

_complexFieldSpecs

List<ComplexFieldSpec> _complexFieldSpecs

_dateTimeFieldSpecs

List<DateTimeFieldSpec> _dateTimeFieldSpecs

_dimensionFieldSpecs

List<DimensionFieldSpec> _dimensionFieldSpecs

_fieldSpecMap

Map<String,FieldSpec> _fieldSpecMap

_hasJSONColumn

boolean _hasJSONColumn

_metricFieldSpecs

List<MetricFieldSpec> _metricFieldSpecs

_primaryKeyColumns

List<String> _primaryKeyColumns

_schemaName

String _schemaName

_timeFieldSpec

TimeFieldSpec _timeFieldSpec

Class org.apache.pinot.spi.data.TimeFieldSpec extends FieldSpec implements Serializable

Serialized Fields

_incomingGranularitySpec

TimeGranularitySpec _incomingGranularitySpec

Deprecated.

_outgoingGranularitySpec

TimeGranularitySpec _outgoingGranularitySpec

Deprecated.

Class org.apache.pinot.spi.data.TimeGranularitySpec extends Object implements Serializable

Serialized Fields

_dataType

FieldSpec.DataType _dataType

Deprecated.

_name

String _name

Deprecated.

_timeFormat

String _timeFormat

Deprecated.

_timeType

TimeUnit _timeType

Deprecated.

_timeUnitSize

int _timeUnitSize

Deprecated.

Package org.apache.pinot.spi.data.readers

Class org.apache.pinot.spi.data.readers.BaseRecordExtractor extends Object implements Serializable

Class org.apache.pinot.spi.data.readers.GenericRow extends Object implements Serializable

Serialized Fields

_fieldToValueMap

Map<String,Object> _fieldToValueMap

_nullValueFields

Set<String> _nullValueFields

Package org.apache.pinot.spi.exception

Class org.apache.pinot.spi.exception.BadQueryRequestException extends RuntimeException implements Serializable

Class org.apache.pinot.spi.exception.EarlyTerminationException extends RuntimeException implements Serializable

Class org.apache.pinot.spi.exception.QueryCancelledException extends RuntimeException implements Serializable

Package org.apache.pinot.spi.filesystem

Class org.apache.pinot.spi.filesystem.BasePinotFS extends Object implements Serializable

Class org.apache.pinot.spi.filesystem.LocalPinotFS extends BasePinotFS implements Serializable

Class org.apache.pinot.spi.filesystem.NoClosePinotFS extends Object implements Serializable

Serialized Fields

_delegate

PinotFS _delegate

Package org.apache.pinot.spi.ingestion.batch.spec

Class org.apache.pinot.spi.ingestion.batch.spec.ExecutionFrameworkSpec extends Object implements Serializable

Serialized Fields

_extraConfigs

Map<String,String> _extraConfigs

Extra configs for execution framework.

_name

String _name

The name of the execution framework, currently supports: Standalone.

_segmentGenerationJobRunnerClassName

String _segmentGenerationJobRunnerClassName

The class implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface.

_segmentMetadataPushJobRunnerClassName

String _segmentMetadataPushJobRunnerClassName

The class implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface.

_segmentTarPushJobRunnerClassName

String _segmentTarPushJobRunnerClassName

The class implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface.

_segmentUriPushJobRunnerClassName

String _segmentUriPushJobRunnerClassName

The class implements org.apache.pinot.spi.ingestion.batch.runner.IngestionJobRunner interface.

Class org.apache.pinot.spi.ingestion.batch.spec.PinotClusterSpec extends Object implements Serializable

Serialized Fields

_controllerURI

String _controllerURI

Controller URI is used to fetch table/schema information and data push. E.g. http://localhost:9000

Class org.apache.pinot.spi.ingestion.batch.spec.PinotFSSpec extends Object implements Serializable

Serialized Fields

_className

String _className

Class name used to create the PinotFS instance. E.g. org.apache.pinot.spi.filesystem.LocalPinotFS is used for local filesystem org.apache.pinot.plugin.filesystem.AzurePinotFS is used for Azure Data Lake org.apache.pinot.plugin.filesystem.HadoopPinotFS is used for HDFS

_configs

Map<String,String> _configs

Configs used to init the PinotFS instances.

_scheme

String _scheme

Scheme used to identify a PinotFS. E.g. local, hdfs, dbfs, etc

Class org.apache.pinot.spi.ingestion.batch.spec.PushJobSpec extends Object implements Serializable

Serialized Fields

_copyToDeepStoreForMetadataPush

boolean _copyToDeepStoreForMetadataPush

Applicable for URI and METADATA push types. If true, and if segment was not already in the deep store, move it to deep store.

_pushAttempts

int _pushAttempts

number of attempts for push job, default is 1, which means no retry.

_pushFileNamePattern

String _pushFileNamePattern

Segments to push file name pattern, supported glob pattern. Sample usage: 'glob:2022/*.tar.gz' will include all segments under _outputDirURI/2022/, but not sub directories; 'glob:**\/stats_*.tar.gz' will include all the segments starting with "stats_" under _outputDirURI recursively.

_pushParallelism

int _pushParallelism

push job parallelism, default is 1.

_pushRetryIntervalMillis

long _pushRetryIntervalMillis

retry wait Ms, default to 1 second.

_segmentUriPrefix

String _segmentUriPrefix

Used in SegmentUriPushJobRunner, which is used to composite the segment uri to send to pinot controller. The URI sends to controller is in the format ${segmentUriPrefix}${segmentPath}${segmentUriSuffix}

_segmentUriSuffix

String _segmentUriSuffix

Class org.apache.pinot.spi.ingestion.batch.spec.RecordReaderSpec extends Object implements Serializable

Serialized Fields

_className

String _className

Corresponding RecordReader class name. E.g. org.apache.pinot.plugin.inputformat.avro.AvroRecordReader org.apache.pinot.plugin.inputformat.csv.CSVRecordReader org.apache.pinot.plugin.inputformat.parquet.ParquetRecordReader org.apache.pinot.plugin.inputformat.json.JSONRecordReader org.apache.pinot.plugin.inputformat.orc.ORCRecordReader org.apache.pinot.plugin.inputformat.thrift.ThriftRecordReader

_configClassName

String _configClassName

Corresponding RecordReaderConfig class name, it's mandatory for CSV and Thrift file format. E.g. org.apache.pinot.plugin.inputformat.csv.CSVRecordReaderConfig org.apache.pinot.plugin.inputformat.thrift.ThriftRecordReaderConfig

_configs

Map<String,String> _configs

Used to init RecordReaderConfig class name, this config is required for CSV and Thrift data format.

_dataFormat

String _dataFormat

Record data format, e.g. 'avro', 'parquet', 'orc', 'csv', 'json', 'thrift' etc.

Class org.apache.pinot.spi.ingestion.batch.spec.SegmentGenerationJobSpec extends Object implements Serializable

Serialized Fields

_authToken

String _authToken

Controller auth token
NOTE: jobs MUST NOT allow references to external tokens via URL or path to prevent: (a) file system crawling (b) unauthorized injection of system tokens from the server's local file system. Instead, resolve tokens right when the job command is run. This allows injection of client-local credentials.

_cleanUpOutputDir

boolean _cleanUpOutputDir

Should clean up output segment on job completion.

_excludeFileNamePattern

String _excludeFileNamePattern

exclude file name pattern, supported glob pattern. Sample usage: 'glob:*.avro' will exclude all avro files just under the inputDirURI, not sub directories; 'glob:**\/*.avro' will exclude all the avro files under inputDirURI recursively.

_executionFrameworkSpec

ExecutionFrameworkSpec _executionFrameworkSpec

Execution framework which this job will be running.

_failOnEmptySegment

boolean _failOnEmptySegment

Should fail segment generation if it's an empty segment.

_includeFileNamePattern

String _includeFileNamePattern

include file name pattern, supported glob pattern. Sample usage: 'glob:*.avro' will include all avro files just under the inputDirURI, not sub directories; 'glob:**\/*.avro' will include all the avro files under inputDirURI recursively.

_inputDirURI

String _inputDirURI

Root directory of input data, expected to have scheme configured in PinotFS.

_jobType

String _jobType

Supported job types are IngestionJobLauncher.PinotIngestionJobType

_outputDirURI

String _outputDirURI

Root directory of output segments, expected to have scheme configured in PinotFS. Note that this is the input directory for jobs that push segments to the Pinot cluster.

_overwriteOutput

boolean _overwriteOutput

Should overwrite output segments if existed.

_pinotClusterSpecs

PinotClusterSpec[] _pinotClusterSpecs

Pinot Cluster related specs

_pinotFSSpecs

List<PinotFSSpec> _pinotFSSpecs

All Pinot FS related specs

_pushJobSpec

PushJobSpec _pushJobSpec

Segment Push job related spec

_recordReaderSpec

RecordReaderSpec _recordReaderSpec

Data file RecordReader related spec

_searchRecursively

boolean _searchRecursively

If true, search input files recursively from root directly specified in _inputDirURI.

_segmentCreationJobParallelism

int _segmentCreationJobParallelism

Segment creation job parallelism.

_segmentNameGeneratorSpec

SegmentNameGeneratorSpec _segmentNameGeneratorSpec

SegmentNameGenerator related spec

_tableSpec

TableSpec _tableSpec

Pinot Table Spec

_tlsSpec

TlsSpec _tlsSpec

TLS setting for controller access

Class org.apache.pinot.spi.ingestion.batch.spec.SegmentGenerationTaskSpec extends Object implements Serializable

Serialized Fields

_customProperties

Map<String,String> _customProperties

Custom properties set into segment metadata

_failOnEmptySegment

boolean _failOnEmptySegment

_inputFilePath

String _inputFilePath

Data file path

_outputDirectoryPath

String _outputDirectoryPath

Output segment directory to host all data files

_recordReaderSpec

RecordReaderSpec _recordReaderSpec

Used to init record reader to read from data file

_schema

Schema _schema

Table schema

_segmentNameGeneratorSpec

SegmentNameGeneratorSpec _segmentNameGeneratorSpec

Used to generate segment name

_sequenceId

int _sequenceId

sequence id

_tableConfig

TableConfig _tableConfig

Table config to create segment

Class org.apache.pinot.spi.ingestion.batch.spec.SegmentNameGeneratorSpec extends Object implements Serializable

Serialized Fields

_configs

Map<String,String> _configs

Configs to init SegmentNameGenerator.

_type

String _type

Current supported type is 'simple' and 'normalizedDate'.

Class org.apache.pinot.spi.ingestion.batch.spec.TableSpec extends Object implements Serializable

Serialized Fields

_schemaURI

String _schemaURI

schemaURI defines where to read the table schema. Supports using PinotFS or HTTP. E.g. hdfs://path/to/table_schema.json http://localhost:9000/tables/myTable/schema

_tableConfigURI

String _tableConfigURI

tableConfigURI defines where to reade the table config. Supports using PinotFS or HTTP. E.g. hdfs://path/to/table_config.json http://localhost:9000/tables/myTable Note that the API to read Pinot table config directly from pinot controller contains a JSON wrapper. The real table config is the object under the field 'OFFLINE'.

_tableName

String _tableName

Table name

Package org.apache.pinot.spi.stream

Class org.apache.pinot.spi.stream.PermanentConsumerException extends RuntimeException implements Serializable

Class org.apache.pinot.spi.stream.TransientConsumerException extends RuntimeException implements Serializable

Package org.apache.pinot.spi.utils

Class org.apache.pinot.spi.utils.ByteArray extends Object implements Serializable

Serialized Fields

_bytes

byte[] _bytes

_hash

int _hash

Package org.apache.pinot.spi.utils.retry

Class org.apache.pinot.spi.utils.retry.AttemptFailureException extends Exception implements Serializable

Class org.apache.pinot.spi.utils.retry.AttemptsExceededException extends AttemptFailureException implements Serializable

Class org.apache.pinot.spi.utils.retry.RetriableOperationException extends AttemptFailureException implements Serializable