Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addChild(ExplorerSearcher.Tree) - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
Adds a child tree.
- addContextVariable(String, Object) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Adds a context variable to be available within the evaluation of an EL, but not in the EL itself.
- additionalDepth() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
How many levels of children elements of the schema element being searched should be displayed by Explorer UI.
- additionalDrivenBindings() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
Used to specify additional configs to schemaElement bindings when the binding config are
DRIVER
orDRIVEN
. - additionalPositionAt() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
Used to specify the configs that should be used to position on the result tree.
- addRecord(Record) - Method in interface com.streamsets.pipeline.api.base.SingleLaneProcessor.SingleLaneBatchMaker
-
Adds a record to the
SingleLaneBatchMaker
. - addRecord(Record, String...) - Method in interface com.streamsets.pipeline.api.BatchMaker
-
Adds a record to the
BatchMaker
. - addResponse(Record) - Method in interface com.streamsets.pipeline.api.SourceResponseSink
-
Processors or destinations can use this method to add a response to the batch being processed.
- addVariable(String, Object) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Adds a variable to be available in the EL being evaluated.
- adjustBatchTime(long) - Method in interface com.streamsets.pipeline.api.BatchContext
-
Adjusts the batch time, the adjustment is in milliseconds, it can be a positive or negative value.
- ADVANCED - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.DisplayMode
- afterRead(int) - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- afterRead(int) - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- afterRead(int) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invoked by the read methods after the proxied call has returned successfully.
- allVersions(String, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Return all versions associated with given object.
- also(String) - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
Used to indicate the schema element allows an additional element type.
- also(String, String) - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
Used to indicate the schema element allows an additional element type with an icon.
- AMAZON - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- AMAZON - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- annotation() - Method in class com.streamsets.pipeline.api.ext.json.delegate.ClassDelegate
- annotation() - Method in class com.streamsets.pipeline.api.ext.json.delegate.LocalDateTimeDelegate
- annotation() - Method in class com.streamsets.pipeline.api.ext.json.delegate.ZonedDateTimeDelegate
- annotation() - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
As json delegates act on fields, it is possible to pass necessary processing information to this delegate through a
JsonRule
annotation. - annotationType() - Method in class com.streamsets.pipeline.api.PlaceholderBean
- AntennaDoctorMessage - Class in com.streamsets.pipeline.api
-
Suggestion on remedy of an issue from Antenna Doctor.
- AntennaDoctorMessage(String, String) - Constructor for class com.streamsets.pipeline.api.AntennaDoctorMessage
- API - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- API - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- API_00 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_01 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_02 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_03 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_04 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_05 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_06 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_07 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_08 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_09 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_10 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_11 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_12 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_13 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_14 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_15 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_16 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_17 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_18 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_19 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_20 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_21 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_22 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_23 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_24 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_25 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- API_26 - Enum constant in enum class com.streamsets.pipeline.api.base.Errors
- ARRAY_OBJECTS - Enum constant in enum class com.streamsets.pipeline.api.ext.json.Mode
- asAtom() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
If this element is an
Atom
it returns anOptional
with it, else it returns an emptyOptional
. - asSet() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
If this element is an
Set
it returns anOptional
with it, else it returns an emptyOptional
. - AT_LEAST_ONCE - Enum constant in enum class com.streamsets.pipeline.api.DeliveryGuarantee
- AT_MOST_ONCE - Enum constant in enum class com.streamsets.pipeline.api.DeliveryGuarantee
- Atom(String) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.Atom
-
Creates an Atom schema element with no icon.
- Atom(String, String) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.Atom
-
Creates an Atom schema element with an icon.
- AURORA - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- AURORA - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- AWS - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- AWS - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
B
- BASE64 - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Upload
- BaseEnumChooserValues<T extends Enum> - Class in com.streamsets.pipeline.api.base
-
Base
ChooserValues
implementation for enums. - BaseEnumChooserValues(Class<? extends Enum>) - Constructor for class com.streamsets.pipeline.api.base.BaseEnumChooserValues
-
Creates a
ChooserValues
with all the enum values of the given enum class. - BaseEnumChooserValues(T...) - Constructor for class com.streamsets.pipeline.api.base.BaseEnumChooserValues
-
Creates a
ChooserValues
with the specified enum values. - BaseExecutor - Class in com.streamsets.pipeline.api.base
- BaseExecutor() - Constructor for class com.streamsets.pipeline.api.base.BaseExecutor
- BaseFieldProcessor - Class in com.streamsets.pipeline.api.base
-
Field processor implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BaseFieldProcessor() - Constructor for class com.streamsets.pipeline.api.base.BaseFieldProcessor
- BaseInterceptor - Class in com.streamsets.pipeline.api.interceptor
- BaseInterceptor() - Constructor for class com.streamsets.pipeline.api.interceptor.BaseInterceptor
- BaseProcessor - Class in com.streamsets.pipeline.api.base
-
Processor implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BaseProcessor() - Constructor for class com.streamsets.pipeline.api.base.BaseProcessor
- BasePushSource - Class in com.streamsets.pipeline.api.base
-
Push Source implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BasePushSource() - Constructor for class com.streamsets.pipeline.api.base.BasePushSource
- BaseService - Class in com.streamsets.pipeline.api.base
- BaseService() - Constructor for class com.streamsets.pipeline.api.base.BaseService
- BaseSource - Class in com.streamsets.pipeline.api.base
-
Source implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BaseSource() - Constructor for class com.streamsets.pipeline.api.base.BaseSource
- BaseStage<C extends Stage.Context> - Class in com.streamsets.pipeline.api.base
-
Stage implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BaseStage() - Constructor for class com.streamsets.pipeline.api.base.BaseStage
- BaseStageLibraryDelegate - Class in com.streamsets.pipeline.api.delegate
- BaseStageLibraryDelegate() - Constructor for class com.streamsets.pipeline.api.delegate.BaseStageLibraryDelegate
- BaseTarget - Class in com.streamsets.pipeline.api.base
-
Target implementation providing empty Data Collector lifecycle methods and convenience methods for subclasses.
- BaseTarget() - Constructor for class com.streamsets.pipeline.api.base.BaseTarget
- BASIC - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.DisplayMode
- Batch - Interface in com.streamsets.pipeline.api
- BATCH - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- BatchContext - Interface in com.streamsets.pipeline.api
-
Context for a batch, primarily used in PushSource to start and finish execution of a batch.
- BatchMaker - Interface in com.streamsets.pipeline.api
- beforeRead(int) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invoked by the read methods before the call is proxied.
- beta() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates if this stage implementation is beta.
- binding() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
- bisectable() - Element in annotation interface com.streamsets.pipeline.api.StageDef
- BlobStore - Interface in com.streamsets.pipeline.api
-
General store for various data used by SDC and its various components.
- BlobStore.VersionedContent - Interface in com.streamsets.pipeline.api
-
Sub-interface to encapsulate tuple of content with it's version.
- BlobStoreDef - Class in com.streamsets.pipeline.api
- BlobStoreDef(String, String) - Constructor for class com.streamsets.pipeline.api.BlobStoreDef
- BlobStoreDef(String, String, long) - Constructor for class com.streamsets.pipeline.api.BlobStoreDef
- blobStoreResource(InterceptorCreator.BaseContext) - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator
-
This method packs information about Blobstore resource that this Interceptor uses.
- BOOLEAN - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- BOOLEAN - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- brandOf() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the original stage it brands.
- BUILTIN - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Strategy
- BUNDLES_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- BYTE - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- BYTE_ARRAY - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
C
- CHAR - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- CHARACTER - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- ChooserValues - Interface in com.streamsets.pipeline.api
-
ChooserValues
provide a list of values and localizable labels for stage configurations using one of the following models:ValueChooserModel
orMultiValueChooserModel
. - CLASS - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
- CLASS_LOADER - Static variable in interface com.streamsets.pipeline.api.ext.json.delegate.ClassDelegate.Parameters
- ClassDelegate - Class in com.streamsets.pipeline.api.ext.json.delegate
-
JSON Delegate used to produce Human-readable strings from Class objects.
- ClassDelegate(JsonRule) - Constructor for class com.streamsets.pipeline.api.ext.json.delegate.ClassDelegate
- ClassDelegate.Parameters - Interface in com.streamsets.pipeline.api.ext.json.delegate
- clone() - Method in class com.streamsets.pipeline.api.Field
-
Returns a clone of the field.
- cloneRecord(Record) - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Deprecated.Use cloneRecord(Record, String) instead.
- cloneRecord(Record, String) - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Clones a record.
- close() - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
close()
method. - close() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataGenerator
-
Close underlying stream.
- close() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataParser
-
Close underlying stream.
- CLUSTER - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
-
Deprecated.
- CLUSTER_BATCH - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- CLUSTER_MESOS_STREAMING - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- CLUSTER_YARN_STREAMING - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- ClusterJob - Interface in com.streamsets.pipeline.api.delegate.exported
-
Delegate interface to manage cluster pipeline jobs.
- ClusterJob.Client - Interface in com.streamsets.pipeline.api.delegate.exported
-
Client to interact with a cluster for running cluster pipelines.
- COLLECTOR - Enum constant in enum class com.streamsets.pipeline.api.ConnectionEngine
- com.streamsets.pipeline.api - package com.streamsets.pipeline.api
-
Data Collector API
- com.streamsets.pipeline.api.base - package com.streamsets.pipeline.api.base
-
Convenience Data Collector API classes
- com.streamsets.pipeline.api.base.configurablestage - package com.streamsets.pipeline.api.base.configurablestage
- com.streamsets.pipeline.api.credential - package com.streamsets.pipeline.api.credential
- com.streamsets.pipeline.api.delegate - package com.streamsets.pipeline.api.delegate
- com.streamsets.pipeline.api.delegate.exported - package com.streamsets.pipeline.api.delegate.exported
- com.streamsets.pipeline.api.el - package com.streamsets.pipeline.api.el
-
Data Collector API EL (expression language) classes
- com.streamsets.pipeline.api.ext.io - package com.streamsets.pipeline.api.ext.io
- com.streamsets.pipeline.api.ext.json - package com.streamsets.pipeline.api.ext.json
- com.streamsets.pipeline.api.ext.json.delegate - package com.streamsets.pipeline.api.ext.json.delegate
- com.streamsets.pipeline.api.gateway - package com.streamsets.pipeline.api.gateway
- com.streamsets.pipeline.api.impl.annotationsprocessor - package com.streamsets.pipeline.api.impl.annotationsprocessor
- com.streamsets.pipeline.api.interceptor - package com.streamsets.pipeline.api.interceptor
- com.streamsets.pipeline.api.lineage - package com.streamsets.pipeline.api.lineage
- com.streamsets.pipeline.api.service - package com.streamsets.pipeline.api.service
- com.streamsets.pipeline.api.service.dataformats - package com.streamsets.pipeline.api.service.dataformats
- com.streamsets.pipeline.api.service.dataformats.log - package com.streamsets.pipeline.api.service.dataformats.log
- com.streamsets.pipeline.api.service.sshtunnel - package com.streamsets.pipeline.api.service.sshtunnel
- commit() - Method in class com.streamsets.pipeline.api.base.configurablestage.DTargetOffsetCommitTrigger
- commit() - Method in interface com.streamsets.pipeline.api.OffsetCommitTrigger
-
Indicates if data collector must commit offset on completion of current batch
- commit(String) - Method in class com.streamsets.pipeline.api.base.configurablestage.DSourceOffsetCommitter
- commit(String) - Method in interface com.streamsets.pipeline.api.OffsetCommitter
-
Invoked by the Data Collector after the completion of each batch to signal the
Source
that the batch has been fully processed. - commitOffset(String, String) - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Registers offset for given origin driven entity.
- complete(Record) - Method in interface com.streamsets.pipeline.api.ProcessedContext
-
Signals that the record has been fully processed for output metrics calculation.
- complete(Collection<Record>) - Method in interface com.streamsets.pipeline.api.ProcessedContext
-
Signals that this list of records has been fully processed for output metrics calculation.
- completeBatch() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- CompositeConfigDef - Annotation Interface in com.streamsets.pipeline.api
-
A composed config is an artifact for the UI to show, in read-only form, multiple configs as a single one.
- CompositeConfigDef.Config - Annotation Interface in com.streamsets.pipeline.api
- Config - Class in com.streamsets.pipeline.api
-
A
Config
bean holds a configuration (both name and value) of a stage. - Config(String, Object) - Constructor for class com.streamsets.pipeline.api.Config
-
Creates a
Config
bean. - ConfigDef - Annotation Interface in com.streamsets.pipeline.api
-
The
ConfigDef
annotation is used to define stage configuration variables and their visual representation in the UI. - ConfigDef.DisplayMode - Enum Class in com.streamsets.pipeline.api
-
Display mode for the configuration when authoring pipelines.
- ConfigDef.Evaluation - Enum Class in com.streamsets.pipeline.api
-
Enum defining the possible EL evaluation modes for configuration variables.
- ConfigDef.Mode - Enum Class in com.streamsets.pipeline.api
-
Enum defining the possible UI syntax highlighting for a configuration of type
ConfigDef.Type.TEXT
. - ConfigDef.Type - Enum Class in com.streamsets.pipeline.api
-
Enum defining the possible types of the configuration variable.
- ConfigDef.Upload - Enum Class in com.streamsets.pipeline.api
-
Defines the upload capability for a configuration.
- ConfigDefBean - Annotation Interface in com.streamsets.pipeline.api
-
Used to define a configuration bean for stages.
- ConfigGroups - Annotation Interface in com.streamsets.pipeline.api
-
Annotation to define the configuration groups for a stage.
- ConfigIssue - Interface in com.streamsets.pipeline.api
-
Standalone class representing configuration issue.
- ConfigIssueContext - Interface in com.streamsets.pipeline.api
-
Interface for creating
ConfigIssue
instances. - configName() - Element in annotation interface com.streamsets.pipeline.api.Dependency
-
The name of the configuration this configuration depends on, if any.
- configs() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef
-
Configs, in display order, used to compose the display value.
- configuration() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDependency
-
Compile time configuration for the service.
- Configuration - Interface in com.streamsets.pipeline.api
-
Interface to retrieve typed configuration from configuration files.
- CONNECTION_DEF_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- CONNECTION_SELECT_MANUAL - Static variable in class com.streamsets.pipeline.api.ConnectionDef.Constants
-
Expected
Dependency.triggeredByValues()
value forConfigDef.connectionType()
field which denotes manual entry forConnectionDef
object attributes. - CONNECTION_VERIFIER - Enum constant in enum class com.streamsets.pipeline.api.HideStage.Type
-
Connection verifier stages are used by Control Hub to verify connections in pipeline previews.
- CONNECTION_VERIFIERS_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- ConnectionChooserValues() - Constructor for class com.streamsets.pipeline.api.ConnectionDef.Constants.ConnectionChooserValues
- ConnectionDef - Annotation Interface in com.streamsets.pipeline.api
-
The
ConnectionDef
annotation is used to designate Config Beans as being Connection Definitions too. - ConnectionDef.Constants - Class in com.streamsets.pipeline.api
- ConnectionDef.Constants.ConnectionChooserValues - Class in com.streamsets.pipeline.api
-
ChooserValues
for theConfigDef.connectionType()
field. - ConnectionEngine - Enum Class in com.streamsets.pipeline.api
-
The possible execution engines that a Connection can support.
- connectionFieldName() - Element in annotation interface com.streamsets.pipeline.api.ConnectionVerifierDef
-
The name of the connection bean of the verifier
- CONNECTIONS_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- connectionSelectionFieldName() - Element in annotation interface com.streamsets.pipeline.api.ConnectionVerifierDef
-
he name of the connection selection field of the verifier
- connectionType() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates that this field is a "connection selection" field for a particular Connection Type (see
ConnectionDef.type()
. - ConnectionVerifier - Class in com.streamsets.pipeline.api
-
Allows Connections to verify their configuration.
- ConnectionVerifier() - Constructor for class com.streamsets.pipeline.api.ConnectionVerifier
- ConnectionVerifierDef - Annotation Interface in com.streamsets.pipeline.api
- Constants() - Constructor for class com.streamsets.pipeline.api.ConnectionDef.Constants
- CONSUMER - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- CONSUMER - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- content() - Method in interface com.streamsets.pipeline.api.BlobStore.VersionedContent
-
Actual content
- CountingReader - Class in com.streamsets.pipeline.api.ext.io
- CountingReader(Reader) - Constructor for class com.streamsets.pipeline.api.ext.io.CountingReader
- create(boolean) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
BOOLEAN
field. - create(byte) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
BYTE
field. - create(byte[]) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
BYTE_ARRAY
field. - create(char) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
CHAR
field. - create(double) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
DOUBLE
field. - create(float) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
FLOAT
field. - create(int) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
INTEGER
field. - create(long) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
LONG
field. - create(short) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
SHORT
field. - create(Field.Type, T) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a field of a given type, the value is converted to the specified type.
- create(Field.Type, T, Map<String, String>) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a field of a given type, the value is converted to the specified type.
- create(Field, T) - Static method in class com.streamsets.pipeline.api.Field
-
Deprecated.DO NOT USE, TO BE REMOVED
- create(FileRef) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
FILE_REF
field. - create(InterceptorCreator.Context) - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator
-
Create interceptor if needed for given stage.
- create(String) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
STRING
field. - create(BigDecimal) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
DECIMAL
Field. - create(List<Field>) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
LIST
field. - create(Map<String, Field>) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
LIST
field. - createCluster(String) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Creates a cluster.
- createConfigIssue(ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.credential.CredentialStore.Context
-
Creates a configuration issue (at initialization time).
- createConfigIssue(ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Creates a configuration issue for the interceptor (at initialization time).
- createConfigIssue(ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher.Context
-
Creates a configuration issue for the publisher (at initialization time).
- createConfigIssue(String, String, ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.ConfigIssueContext
-
Creates a configuration issue for the given ConfigDef.
- createCounter(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Counter
namespaced with the pipeline name and the stage instance name plus the given name. - createDate(Date) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
DATE
field. - createDatetime(Date) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
DATETIME
field. - createELEval(String) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.ELContext
-
Creates an
ELEval
configured with the EL functions and constants defined by the indicated stage configuration. - createELEval(String, Class<?>...) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.ELContext
-
Creates an
ELEval
configured with the EL functions and constants defined by the indicated stage configuration plus the additional EL functions and constants specified. - createELVars() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.ELContext
- createEventRecord(String, int, String) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Creates standard event record with pre-filled required header attributes.
- createExecutor() - Method in class com.streamsets.pipeline.api.base.configurablestage.DExecutor
- createGauge(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Gauge
namespaced with the pipeline name and the stage instance name plus the given name. - createGauge(String, Comparator<String>) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Gauge
namespaced with the pipeline name and the stage instance name plus the given name. - createHistogram(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Histogram
namespaced with the pipeline name and the stage instance name plus the given name. - createInputStream(ProtoConfigurableEntity.Context, Class<T>) - Method in class com.streamsets.pipeline.api.FileRef
-
Creates the Stream instance based on the stream class type.
- createLineageEvent(LineageEventType) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Creates a LineageEvent and initializes the general fields.
- createListMap(LinkedHashMap<String, Field>) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
LIST_MAP
field. - createMeter(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Meter
namespaced with the pipeline name and the stage instance name plus the given name. - createProcessor() - Method in class com.streamsets.pipeline.api.base.configurablestage.DProcessor
- createPushSource() - Method in class com.streamsets.pipeline.api.base.configurablestage.DPushSource
- createRecord(Record) - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Creates an empty record indicating another record as its source.
- createRecord(Record, byte[], String) - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Creates an empty record indicating another record as its source, including the original raw data of the record.
- createRecord(Record, String) - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Creates an empty record indicating another record as its source.
- createRecord(String) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Creates an empty record.
- createRecord(String, byte[], String) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Creates an empty record including the original raw data of the record.
- createSource() - Method in class com.streamsets.pipeline.api.base.configurablestage.DSource
- createStage(String, Class<S>) - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Instantiate and initialize given stage definition.
- createTarget() - Method in class com.streamsets.pipeline.api.base.configurablestage.DTarget
- createTime(Date) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
TIME
field. - createTimer(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Creates a
Timer
namespaced with the pipeline name and the stage instance name plus the given name. - createVariables() - Method in class com.streamsets.pipeline.api.el.ELEval
-
Returns an empty
ELVars
instance. - createZonedDateTime(ZonedDateTime) - Static method in class com.streamsets.pipeline.api.Field
-
Creates a
ZONED_DATETIME
field. - CREATION_TIMESTAMP - Static variable in interface com.streamsets.pipeline.api.EventRecord
-
Timestamp of the time when the event was generated.
- creator() - Element in annotation interface com.streamsets.pipeline.api.interceptor.InterceptorDef
-
Creator that will be used for the instantiation.
- CREDENTIAL - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- CREDENTIAL_STORE_DEF_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- CREDENTIAL_STORE_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- CredentialStore - Interface in com.streamsets.pipeline.api.credential
-
A credential store gives programmatic access, via a reference name, to sensitive values such as system passwords.
- CredentialStore.ConfigIssue - Interface in com.streamsets.pipeline.api.credential
-
Marker interface for configuration issues.
- CredentialStore.Context - Interface in com.streamsets.pipeline.api.credential
-
Context provided to credential store implementations at initialization time.
- CredentialStoreDef - Annotation Interface in com.streamsets.pipeline.api.credential
-
Declares an implementation of a
CredentialStore
for auto-discovery. - CredentialValue - Interface in com.streamsets.pipeline.api.credential
-
Type for Stage configuration variables using
${credential:get(...)}
EL functions.
D
- DATA_PARSER_00 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.Errors
- DATABASE - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
- DATABRICKS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- DataFormatGeneratorService - Interface in com.streamsets.pipeline.api.service.dataformats
-
Service that allows serializing records to various file formats.
- DataFormatParserService - Interface in com.streamsets.pipeline.api.service.dataformats
-
Service for parsing various data formats from input streams.
- DataGenerator - Interface in com.streamsets.pipeline.api.service.dataformats
- DataGeneratorException - Exception in com.streamsets.pipeline.api.service.dataformats
-
General exception for data format related issues.
- DataGeneratorException(ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.service.dataformats.DataGeneratorException
-
Exception constructor.
- DataParser - Interface in com.streamsets.pipeline.api.service.dataformats
- DataParserException - Exception in com.streamsets.pipeline.api.service.dataformats
- DataParserException(ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.service.dataformats.DataParserException
-
Exception constructor.
- DATE - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- DATETIME - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- DClusterSourceOffsetCommitter - Class in com.streamsets.pipeline.api.base.configurablestage
- DClusterSourceOffsetCommitter() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- DECIMAL - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- Default() - Constructor for class com.streamsets.pipeline.api.StageUpgrader.Default
- DEFAULT_READ_LIMIT - Static variable in class com.streamsets.pipeline.api.ext.io.OverrunReader
- defaultValue() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The default value for the configuration variable.
- defaultValueFromResource() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Use instead of defaultValue to read a text resource in with UTF-8 as a String and use it as the defaultValue.
- delegate() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRule
- delegate() - Method in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
- DELEGATE_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- DELEGATED - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Strategy
- delete(String) - Method in interface com.streamsets.pipeline.api.credential.ManagedCredentialStore
-
Deletes a credential stored
- delete(String) - Method in interface com.streamsets.pipeline.api.Record
-
Deletes the
Field
at the specified field-path. - delete(String, String, long) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Delete given object from the store.
- deleteAllVersions(String, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Delete all versions of given object.
- deleteAttribute(String) - Method in class com.streamsets.pipeline.api.Field
-
Deletes an attribute.
- deleteAttribute(String) - Method in interface com.streamsets.pipeline.api.Record.Header
-
Deletes an attribute.
- deleteJobFiles(Properties) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Deletes pipeline job files used to run the job from the filesystem accessible to the cluster once the pipeline job ended.
- DeliveryGuarantee - Enum Class in com.streamsets.pipeline.api
-
Delivery guarantee of a pipeline.
- dependencies() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
List of Dependency instances that can specify the parameters and their respective trigger values that this configName depends on.
- dependencies() - Element in annotation interface com.streamsets.pipeline.api.ConfigDefBean
- Dependency - Annotation Interface in com.streamsets.pipeline.api
-
A Dependency specifies a configuration this config depends on.
- dependsOn() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The name of the configuration this configuration depends on, if any.
- description() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef
-
The default tooltip description for the UI.
- description() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The default tooltip description for the UI.
- description() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
A user-facing description for this Connection Definition.
- description() - Element in annotation interface com.streamsets.pipeline.api.credential.CredentialStoreDef
-
Indicates the UI default description for the credential store.
- description() - Element in annotation interface com.streamsets.pipeline.api.ElConstant
-
Description of the constant, for the UI help.
- description() - Element in annotation interface com.streamsets.pipeline.api.ElFunction
-
Description of the constant, for the UI help.
- description() - Element in annotation interface com.streamsets.pipeline.api.EventDef
-
Description of the event
- description() - Element in annotation interface com.streamsets.pipeline.api.EventFieldDef
-
Description of the field
- description() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
- description() - Element in annotation interface com.streamsets.pipeline.api.lineage.LineagePublisherDef
-
Indicates the UI default description for the publisher.
- description() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Indicates the UI default description for the stage.
- description() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the UI default description for the stage.
- DESCRIPTION - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- deserialize(String, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.ClassDelegate
- deserialize(String, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.LocalDateTimeDelegate
- deserialize(String, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.ZonedDateTimeDelegate
- deserialize(String, Map<String, Object>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
This method is invoked when one annotated field is marked as using this custom deserialization procedure.
- destroy() - Method in class com.streamsets.pipeline.api.base.BaseService
-
Destroy the service.
- destroy() - Method in class com.streamsets.pipeline.api.base.BaseStage
-
Destroy the stage.
- destroy() - Method in class com.streamsets.pipeline.api.base.configurablestage.DStage
- destroy() - Method in class com.streamsets.pipeline.api.ConnectionVerifier
- destroy() - Method in interface com.streamsets.pipeline.api.credential.CredentialStore
-
Destroys the credential store.
- destroy() - Method in class com.streamsets.pipeline.api.interceptor.BaseInterceptor
-
Default implementation of destroy does not do anything.
- destroy() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor
-
Destroys the interceptor.
- destroy() - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher
-
Destroys the plugin.
- destroy() - Method in interface com.streamsets.pipeline.api.service.Service
-
Destroys the service.
- destroy() - Method in interface com.streamsets.pipeline.api.Stage
-
Destroys the stage.
- destroyConnection() - Method in class com.streamsets.pipeline.api.ConnectionVerifier
-
Destroys the Connection, if applicable.
- destroyLoader() - Method in interface com.streamsets.pipeline.api.ExplorerLoader
-
Destroy the loader.
- destroySearcher() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher
-
Destroys the search.
- DEVDATA - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- DExecutor - Class in com.streamsets.pipeline.api.base.configurablestage
- DExecutor() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DExecutor
- discard() - Method in class com.streamsets.pipeline.api.ExplorerData
-
Called when the instance is being discarded to it can clean up and free any resources it may have.
- DISCARD - Enum constant in enum class com.streamsets.pipeline.api.OnRecordError
- displayMode() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Display mode for the configuration, defaults to BASIC (always shown).
- displayPosition() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef
-
The display position in the UI.
- displayPosition() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The display position in the UI.
- DOUBLE - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- DProcessor - Class in com.streamsets.pipeline.api.base.configurablestage
- DProcessor() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DProcessor
- DPushSource - Class in com.streamsets.pipeline.api.base.configurablestage
- DPushSource() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DPushSource
- DRIVEN - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
A configuration with
DRIVEN
binding will do a search restricting the search domain to the current values for the configurations withDRIVER
andDRIVER_PARENT
bindings with the same explorer ID. - DRIVER - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
A configuration with
DRIVER
binding can trigger an explorer search, and it is filled in with the searched 'schemaElement'. - DRIVER_PARENT - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
A configuration with
DRIVER_PARENT
binding is filled with the corresponding 'schemaElement' from the explorer search selection done by theDRIVER
configuration (same explorer ID). - drop() - Method in interface com.streamsets.pipeline.api.FieldOperator
-
Drop the field that the cursor is pointing to.
- DSource - Class in com.streamsets.pipeline.api.base.configurablestage
- DSource() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DSource
- DSourceOffsetCommitter - Class in com.streamsets.pipeline.api.base.configurablestage
- DSourceOffsetCommitter() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DSourceOffsetCommitter
- DStage<C extends Stage.Context> - Class in com.streamsets.pipeline.api.base.configurablestage
- DStage() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DStage
- DTarget - Class in com.streamsets.pipeline.api.base.configurablestage
- DTarget() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DTarget
- DTargetOffsetCommitTrigger - Class in com.streamsets.pipeline.api.base.configurablestage
- DTargetOffsetCommitTrigger() - Constructor for class com.streamsets.pipeline.api.base.configurablestage.DTargetOffsetCommitTrigger
E
- EDGE - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- ElConstant - Annotation Interface in com.streamsets.pipeline.api
-
Defines an EL constant.
- ElDef - Annotation Interface in com.streamsets.pipeline.api
-
Classes annotated with
ElDef
are automatically scanned for EL constants and EL function definitions and they are made available to all configurations of the stage library. - elDefs() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Defines custom EL functions and constants available to EL evalutors of this configuration variable.
- ELDEFS_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- Element(boolean, String, String) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.Element
- ELEval - Class in com.streamsets.pipeline.api.el
-
An
ELEval
instance evaluates Java EL expressions. - ELEval() - Constructor for class com.streamsets.pipeline.api.el.ELEval
- ELEvalException - Exception in com.streamsets.pipeline.api.el
-
Exception thrown if an EL expression could not be evaluated properly.
- ELEvalException(ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.el.ELEvalException
- ElFunction - Annotation Interface in com.streamsets.pipeline.api
-
Defines an EL function.
- ElParam - Annotation Interface in com.streamsets.pipeline.api
-
Methods defined as EL functions must use this annotation to give the UI name to the EL function parameters.
- ELVars - Interface in com.streamsets.pipeline.api.el
-
The
ELVars
hold all constants, variables and context variables available during an EL evaluation. - emptyBatch() - Method in class com.streamsets.pipeline.api.base.RecordTarget
-
Called if the batch to write does not have any records to allow the
RecordTarget
to do a special handling in those situations. - emptyBatch(SingleLaneProcessor.SingleLaneBatchMaker) - Method in class com.streamsets.pipeline.api.base.SingleLaneRecordProcessor
-
Called if the batch to process does not have any records to allow the
RecordProcessor
to do a special handling in those situations. - emptyBatch(BatchMaker) - Method in class com.streamsets.pipeline.api.base.RecordProcessor
-
Called if the batch to process does not have any records to allow the
RecordProcessor
to do a special handling in those situations. - EMR_BATCH - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- ENDPOINT_TYPE - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- EndPointType - Enum Class in com.streamsets.pipeline.api.lineage
- ENTITY_CREATED - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- ENTITY_NAME - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- ENTITY_READ - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- ENTITY_WRITTEN - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- equals(Object) - Method in class com.streamsets.pipeline.api.Field
-
Compares if the field is equal to another field.
- equals(Object) - Method in class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- ERROR_STAGE - Enum constant in enum class com.streamsets.pipeline.api.HideStage.Type
-
This stage should be used as possible target for error records.
- ErrorCode - Interface in com.streamsets.pipeline.api
-
Typifies error codes with built-in localization support.
- ErrorListener - Interface in com.streamsets.pipeline.api
-
If the execution of a pipeline throws an exception, all stages in the pipeline implementing this interface will be notified via the
ErrorListener.errorNotification(Throwable)
method. - errorNotification(Throwable) - Method in interface com.streamsets.pipeline.api.ErrorListener
-
Invoked when the execution of a pipeline throws an exception.
- Errors - Enum Class in com.streamsets.pipeline.api.base
-
Error codes produced by the Data Collector where there is a stage configuration issue.
- Errors - Enum Class in com.streamsets.pipeline.api.service.dataformats
- ErrorStage - Annotation Interface in com.streamsets.pipeline.api
-
Used to define destination (
Target
) stages that specialize in handling records sent to error. - eval(ELVars, String, Class<T>) - Method in class com.streamsets.pipeline.api.el.ELEval
-
Evaluates an EL.
- evaluate(ELVars, String, Class<T>) - Method in class com.streamsets.pipeline.api.el.ELEval
-
Evaluates an EL.
- evaluation() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates if the Data Collector evaluates ELs in the configuration and the stages sees the already resolved value (implicit), or if the Data Collector does not evaluate the EL and the stage must use a
ELEval
to explicitly perform the EL evaluation. - EventDef - Annotation Interface in com.streamsets.pipeline.api
- eventDefs() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Defines event definitions generated by stage.
- EventFieldDef - Annotation Interface in com.streamsets.pipeline.api
- EventRecord - Interface in com.streamsets.pipeline.api
-
Event record is a special Record instance that have few additional required header fields like type, version and creation_time.
- execution() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the stage supported execution modes.
- ExecutionMode - Enum Class in com.streamsets.pipeline.api
-
Defines the execution modes of a pipeline.
- Executor - Interface in com.streamsets.pipeline.api
-
A
Executor
is a special case of a Data collector target. - EXECUTOR - Enum constant in enum class com.streamsets.pipeline.api.StageType
- exists(String, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Validates if given object exists on at least one version.
- exists(String, String, long) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Validates if given object exists on given version.
- EXPLICIT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Evaluation
- explorer() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
If set, it defines how explorer will help the user to set the value for an explorer aware property.
- ExplorerConfigDef - Annotation Interface in com.streamsets.pipeline.api
-
Defines how explorer will help the user to set the value for an explorer aware property.
- ExplorerConfigDef.Binding - Enum Class in com.streamsets.pipeline.api
-
Defines the type of explorer binding the configuration has.
- ExplorerConfigDef.Location - Enum Class in com.streamsets.pipeline.api
-
Location defines where Explorer UI should place, in a configuration, an explorer chosen value.
- ExplorerData<T> - Class in com.streamsets.pipeline.api
-
ExplorerLoader
producesExplorerData
that is used byExplorerSearcher
. - ExplorerData(T) - Constructor for class com.streamsets.pipeline.api.ExplorerData
- explorerId() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
The explorer ID that identifies the explorer view used by a configuration.
- explorerLoad() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
If the stage does load explorer metadata prior to searches.
- ExplorerLoader<T> - Interface in com.streamsets.pipeline.api
-
Loads explorer data to be used for Explorer searches.
- ExplorerLoader.Tabular - Interface in com.streamsets.pipeline.api
-
If a stage provides a loader implementing this loader sub-interface, it is possible to use the engine's built-in
ExplorerSearcher
by indicating in the stage's@StageDef
explorerSearchType = ExplorerSearchType.MANAGED_TABULAR
. - explorerSchema() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Explorer schema for the stage.
- ExplorerSchema - Class in com.streamsets.pipeline.api
-
Class that defines the metadata explorer schema for a stage.
- ExplorerSchema(ExplorerSchema.Element, ExplorerSchema.Element...) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema
-
Constructor.
- ExplorerSchema.Atom - Class in com.streamsets.pipeline.api
-
A leaf schema element.
- ExplorerSchema.Element - Class in com.streamsets.pipeline.api
-
Base schema element class.
- ExplorerSchema.NONE - Class in com.streamsets.pipeline.api
-
Empty schema.
- ExplorerSchema.Set - Class in com.streamsets.pipeline.api
-
A schema element that has one or more children schema element.
- ExplorerSearcher<T> - Interface in com.streamsets.pipeline.api
-
Interface that performs an explorer search against the explorer data produced by the explorer loader.
- ExplorerSearcher.SearchRequest - Interface in com.streamsets.pipeline.api
-
Defines an explorer search request and how to produce the result tree.
- ExplorerSearcher.Tree - Class in com.streamsets.pipeline.api
-
Searches always return a tree.
- explorerSearchType() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
The explorer search type the stage uses.
- ExtendedPropertyValue - Interface in com.streamsets.pipeline.api.lineage
- ExtendedPropertyValueList - Class in com.streamsets.pipeline.api.lineage
- ExtendedPropertyValueList(List<Map<String, ExtendedPropertyValue>>) - Constructor for class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueList
- ExtendedPropertyValueString - Class in com.streamsets.pipeline.api.lineage
- ExtendedPropertyValueString(String) - Constructor for class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueString
F
- Field - Class in com.streamsets.pipeline.api
-
A
Field
is the basic building block to represent data within Data Collector stages. - FIELD_PROCESSOR - Enum constant in enum class com.streamsets.pipeline.api.HideStage.Type
-
Field process is special kind of processor that works on per-field basis rather then per-record basis.
- Field.Type - Enum Class in com.streamsets.pipeline.api
-
Enum defining all
Field
types. - FieldBatch - Interface in com.streamsets.pipeline.api
-
Field batch is used by to transform individual fields rather than whole records.
- FieldOperator - Interface in com.streamsets.pipeline.api
-
Field operator is used by to manipulate fields while avoiding object creation for performance.
- FieldProcessor - Interface in com.streamsets.pipeline.api
-
Field processor is a special kind of processor.
- FieldSelectorModel - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for configuration variables that need to be populated with record field names.
- FieldVisitor - Interface in com.streamsets.pipeline.api
-
Field Visitor interface that enables simple iteration over fields.
- FILE - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
- FILE_REF - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- FileRef - Class in com.streamsets.pipeline.api
-
Class which defines a reference to a file through which streams can be created to the file.
- FileRef(int) - Constructor for class com.streamsets.pipeline.api.FileRef
- filteringConfig() - Element in annotation interface com.streamsets.pipeline.api.ValueChooserModel
-
Name of a List configuration that contains a filter of what entities from given chooser should be indeed displayed.
- findOption(Map<String, Object>, String) - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
Method that finds, for a given necessary runtime parameter, its actual value using its alias.
- finishPipeline() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Deprecated.
- finishPipeline(boolean) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
After current batch, transition pipeline state to FINISHED.
- FIREHOSE - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- FIREHOSE - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- flags() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Flags describing behavior of this stage.
- FLOAT - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- flush() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataGenerator
-
Flush all so far serialized record to the stream.
- forEachField(FieldVisitor) - Method in interface com.streamsets.pipeline.api.Record
-
Call given visitor for each field in this record.
- format() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRule
- FTP - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
G
- GatewayInfo - Interface in com.streamsets.pipeline.api.gateway
-
API Gateway Info, primarily used in the Microservice pipeline to use Data Collector instance as API Gateway.
- GCP - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- GenerateResourceBundle - Annotation Interface in com.streamsets.pipeline.api
-
Annotation to flag the generation of resource bundles for stages and related classes that have labels or messages that show up in the UI and need to be localized.
- get() - Method in interface com.streamsets.pipeline.api.credential.CredentialValue
-
Returns the credential value.
- get() - Method in interface com.streamsets.pipeline.api.Record
-
Returns the root data field of the record.
- get(String) - Method in interface com.streamsets.pipeline.api.Record
-
Returns the
Field
at the specified field-path. - get(String, boolean) - Method in interface com.streamsets.pipeline.api.Configuration
-
Get given conf key as a boolean.
- get(String, int) - Method in interface com.streamsets.pipeline.api.Configuration
-
Get given conf key as a int.
- get(String, long) - Method in interface com.streamsets.pipeline.api.Configuration
-
Get given conf key as a long.
- get(String, String) - Method in interface com.streamsets.pipeline.api.Configuration
-
Get given conf key as a String.
- get(String, String, String) - Method in interface com.streamsets.pipeline.api.credential.CredentialStore
-
Returns a credential value associated to the given name.
- getActiveCluster(String) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Finds a cluster ID based on a cluster name.
- getAdditionalNamesIcons() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
Returns the additional (name, icon) pairs associated with this element.
- getAliasName() - Method in interface com.streamsets.pipeline.api.Stage.UserContext
-
Returns the alias name of the user who started this pipeline or job.
- getAntennaDoctorMessages() - Method in exception com.streamsets.pipeline.api.StageException
-
Returns Antenna Doctor messages associated with this exception.
- getAttribute(String) - Method in class com.streamsets.pipeline.api.Field
-
Returns the value of the specified attribute.
- getAttribute(String) - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the value of the specified attribute.
- getAttributeNames() - Method in class com.streamsets.pipeline.api.Field
-
Returns the list of user defined attribute names.
- getAttributeNames() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the list of user defined attribute names.
- getAttributes() - Method in class com.streamsets.pipeline.api.Field
-
Get all field attributes in an unmodifiable Map, or null if no attributes have been added
- getBatchMaker() - Method in interface com.streamsets.pipeline.api.BatchContext
-
Return batch maker associated with this batch context.
- getBlobStore() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Returns SDC singleton instance for the BLOB store
- getBlobStore() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.BaseContext
-
Returns SDC singleton instance for the BLOB store
- getBufferSize() - Method in class com.streamsets.pipeline.api.FileRef
-
Returns the buffer size of the returned input stream.
- getCharset() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Charset that is used by the service when writing text data.
- getCharset() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Charset that is used by the service when reading text data.
- getChild(String) - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
Returns a child tree, NULL if it does not exist.
- getChildren() - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
Return all the children of a node, NULL if none.
- getChildren() - Method in interface com.streamsets.pipeline.api.lineage.ExtendedPropertyValue
-
Returns a list containing all the property's children.
- getChildren() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueList
- getChildren() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueString
- getChildrenNames(String, int) - Method in class com.streamsets.pipeline.api.ExplorerSchema
-
Returns the children names of an element up to the given child depth.
- getClient(Properties) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob
-
Creates a client to interact with a cluster for running cluster pipelines.
- getClusterStatus(String) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Returns the cluster status.
- getCode() - Method in enum class com.streamsets.pipeline.api.base.Errors
- getCode() - Method in interface com.streamsets.pipeline.api.ErrorCode
-
Returns the error code.
- getCode() - Method in enum class com.streamsets.pipeline.api.service.dataformats.Errors
- getCode() - Method in enum class com.streamsets.pipeline.api.StageUpgrader.Error
- getConfig(String) - Method in interface com.streamsets.pipeline.api.credential.CredentialStore.Context
-
Return value for given configuration option from data collector main configuration.
- getConfig(String) - Method in interface com.streamsets.pipeline.api.delegate.StageLibraryDelegate.Context
-
Return value for given configuration option from data collector main configuration.
- getConfig(String) - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Deprecated.Use getConfiguration() instead.
- getConfig(String) - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.BaseContext
-
Return value for given configuration option from data collector main configuration.
- getConfig(String) - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher.Context
-
Return value for given configuration option from data collector main configuration.
- getConfig(String) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Deprecated.Use getConfiguration() instead.
- getConfigName() - Method in class com.streamsets.pipeline.api.el.ELEval
-
Returns the stage configuration associated with the
ELEval
instance. - getConfigsToShip() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- getConfiguration() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Return configuration object corresponding to the data collector main configuration files.
- getConfiguration() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Return configuration relevant to stages from the data collector main configuration files.
- getConstant(String) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Returns the specified EL constant.
- getContext() - Method in class com.streamsets.pipeline.api.base.BaseService
-
Returns the service context passed by the Data Collector during initialization.
- getContext() - Method in class com.streamsets.pipeline.api.base.BaseStage
-
Returns the stage context passed by the Data Collector during initialization.
- getContext() - Method in class com.streamsets.pipeline.api.delegate.BaseStageLibraryDelegate
- getContext() - Method in class com.streamsets.pipeline.api.interceptor.BaseInterceptor
-
Returns the interceptor context.
- getContextVariable(String) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Returns the context variable value.
- getCount() - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- getCounter(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Gets the already created
Counter
namespaced with the pipeline name and the stage instance name plus the given name. - getData() - Method in class com.streamsets.pipeline.api.ExplorerData
- getDefault(Class) - Method in enum class com.streamsets.pipeline.api.ConfigDef.Type
-
Returns the default value for the configuration type to be used when there is no default value defined.
- getDefaultReadLimit() - Static method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- getDeliveryGuarantee() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.BaseContext
-
Return configured delivery guarantee of the pipeline.
- getDeliveryGuarantee() - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Returns configured delivery guarantee for this pipeline.
- getDescription() - Method in class com.streamsets.pipeline.api.AntennaDoctorMessage
- getElementNames() - Method in class com.streamsets.pipeline.api.ExplorerSchema
-
Returns a set with all the schema elements names, it includes the element names defined via
also()
. - getElements() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Set
-
Returns the children schema elements.
- getEmail() - Method in interface com.streamsets.pipeline.api.Stage.UserContext
-
Return the email address of the user who started this pipeline or job.
- getEmptyData() - Method in interface com.streamsets.pipeline.api.ExplorerLoader
-
Returns an empty data set.
- getEnvironmentVersion() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns the current environment version.
- getErrorCode() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the error code.
- getErrorCode() - Method in exception com.streamsets.pipeline.api.StageException
-
Returns the error code associated with the exception.
- getErrorDataCollectorId() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the UUID of the data collector that sent the record to error.
- getErrorJobId() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Job ID is set when the pipeline has an associated SCH Job ID
- getErrorJobName() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Job Name is set when the pipeline has an associated SCH Job Name
- getErrorMessage() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the error message.
- getErrorPipelineName() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the name of the pipeline that sent the record to error.
- getErrorStackTrace() - Method in interface com.streamsets.pipeline.api.Record.Header
-
StackTrace is set when error record is caused from exceptions.
- getErrorStage() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the stage instance internal unique name that sent the message to error.
- getErrorStageLabel() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the stage label that sent the message to error.
- getErrorTimestamp() - Method in interface com.streamsets.pipeline.api.Record.Header
-
If the record has been sent to error, it returns the timestamp (UNIX Epoch time) when the record was sent to error.
- getEscapedFieldPaths() - Method in interface com.streamsets.pipeline.api.Record
-
Returns all available field-paths in the record.
- getEscapedFieldPathsOrdered() - Method in interface com.streamsets.pipeline.api.Record
-
Returns all available field-paths in the record.
- getEventCreationTimestamp() - Method in interface com.streamsets.pipeline.api.EventRecord
-
Gets the timestamp associated with this event's creation.
- getEventType() - Method in interface com.streamsets.pipeline.api.EventRecord
-
Gets the type of this event, which is set by the event creator.
- getEventType() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - EventType
- getEventVersion() - Method in interface com.streamsets.pipeline.api.EventRecord
-
Gets the version of this event, which is set by the event creator.
- getExecutionMode() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.BaseContext
-
Return execution mode of the pipeline.
- getExecutionMode() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns the current execution mode of the pipeline.
- getExplorerSchema() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns the Explorer definition for the stage, NULL if not set.
- getExtendedProperties() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Gets the extended properties list.
- getExtraConfigs() - Method in interface com.streamsets.pipeline.api.StageUpgrader.ExtendedContext
- getExtraDepth() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
How many extra levels from the schema element being search are wanted in the result tree.
- getField() - Method in interface com.streamsets.pipeline.api.RecordField
-
Field that the cursor is currently pointing to.
- getFieldName() - Method in interface com.streamsets.pipeline.api.RecordField
-
Field name - the last part of field path.
- getFieldPath() - Method in interface com.streamsets.pipeline.api.RecordField
-
Field path of the filed that the cursor is currently pointing to.
- getFieldPaths() - Method in interface com.streamsets.pipeline.api.Record
-
Deprecated.
- getFixedSchemaElements() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
Schema elements and values pairs that restrict the search domain to a subset of the explorer data.
- getFromVersion() - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Current version of the stored configuration.
- getGauge(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Gets the already created
Gauge
namespaced with the pipeline name and the stage instance name plus the given name. - getGenerator(OutputStream) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Retrieve DataGenerator for given output stream.
- getGenerator(OutputStream) - Method in interface com.streamsets.pipeline.api.service.dataformats.SdcRecordGeneratorService
-
Retrieve DataGenerator for given output stream.
- getGroups() - Method in interface com.streamsets.pipeline.api.Stage.UserContext
-
Return the list of groups the user who started this pipeline or job belongs to.
- getGroupsSecretName(String) - Method in interface com.streamsets.pipeline.api.credential.CredentialStore
-
Returns the name of the secret that contains the list of groups that have access right to the passed secret.
- getHeader() - Method in interface com.streamsets.pipeline.api.Record
-
Returns the metadata header of the record.
- getHistogram(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Gets the already created
Histogram
namespaced with the pipeline name and the stage instance name plus the given name. - getHost() - Method in class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- getIcon() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
Returns the element icon.
- getId() - Method in class com.streamsets.pipeline.api.BlobStoreDef
- getId() - Method in interface com.streamsets.pipeline.api.credential.CredentialStore.Context
-
Returns the ID of the store, this ID is defined by configuration.
- getId() - Static method in class com.streamsets.pipeline.api.el.SdcEL
- getId() - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher.Context
-
Returns the ID of the publisher, this ID is defined by configuration.
- getIndexInParent() - Method in interface com.streamsets.pipeline.api.RecordField
-
Index of the field that the cursor is currently pointing to, within a parent LIST type field, if applicable.
- getInfo() - Method in class com.streamsets.pipeline.api.base.BaseStage
-
Returns the stage information passed by the Data Collector during initialization.
- getInstanceName() - Method in interface com.streamsets.pipeline.api.Stage.Info
-
Returns the instance name of the stage.
- getInterceptorType() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.Context
-
Return type of the interceptor (where exactly it will be called).
- getJobStatus(Properties) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Returns the pipeline job status.
- getKeyTextValue(String) - Method in interface com.streamsets.pipeline.api.ext.json.JsonModel
-
Seeks for a key inside the JSON tree.
- getLabel() - Method in enum class com.streamsets.pipeline.api.DeliveryGuarantee
- getLabel() - Method in enum class com.streamsets.pipeline.api.ExecutionMode
-
Returns the default value of localizable label, for the UI, of the execution mode enum.
- getLabel() - Method in interface com.streamsets.pipeline.api.Label
-
Returns the default label.
- getLabel() - Method in enum class com.streamsets.pipeline.api.lineage.EndPointType
- getLabel() - Method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- getLabel() - Method in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
- getLabel() - Method in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
- getLabel() - Method in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- getLabel() - Method in enum class com.streamsets.pipeline.api.OnRecordError
- getLabel() - Method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- getLabel() - Method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileExistsAction
- getLabel() - Method in interface com.streamsets.pipeline.api.Stage.Info
-
Returns the label that user configured for this stage.
- getLabel() - Method in enum class com.streamsets.pipeline.api.StageDef.DefaultInputStreams
- getLabel() - Method in enum class com.streamsets.pipeline.api.StageDef.DefaultOutputStreams
- getLabel() - Method in enum class com.streamsets.pipeline.api.StageDef.VariableOutputStreams
- getLabels() - Method in class com.streamsets.pipeline.api.base.BaseEnumChooserValues
- getLabels() - Method in interface com.streamsets.pipeline.api.ChooserValues
-
Returns the list of labels for the values.
- getLabels() - Method in class com.streamsets.pipeline.api.ConnectionDef.Constants.ConnectionChooserValues
- getLanes() - Method in interface com.streamsets.pipeline.api.BatchMaker
-
Returns the available lane names (stream names) for the stage.
- getLastBatchTime() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns the time of completion of the previous batch.
- getLen() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
The length of the results.
- getLibrary() - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Stage Library name
- getLocalizedMessage() - Method in exception com.streamsets.pipeline.api.StageException
-
Returns the exception message, localized.
- getLogParser(String, Reader) - Method in interface com.streamsets.pipeline.api.service.dataformats.log.LogParserService
- getLogParser(String, Reader, long) - Method in interface com.streamsets.pipeline.api.service.dataformats.log.LogParserService
-
Returns a parser to be used to parse logs
- getLogParser(String, String) - Method in interface com.streamsets.pipeline.api.service.dataformats.log.LogParserService
- getMessage() - Method in enum class com.streamsets.pipeline.api.base.Errors
- getMessage() - Method in interface com.streamsets.pipeline.api.ErrorCode
-
Returns the built-in default message for the error code.
- getMessage() - Method in enum class com.streamsets.pipeline.api.service.dataformats.Errors
- getMessage() - Method in exception com.streamsets.pipeline.api.StageException
-
Returns the exception message, not localized.
- getMessage() - Method in enum class com.streamsets.pipeline.api.StageUpgrader.Error
- getMeter(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Gets the already created
Meter
namespaced with the pipeline name and the stage instance name plus the given name. - getMetrics() - Method in interface com.streamsets.pipeline.api.MetricContext
-
Returns the
MetricRegistry
used by the pipeline. - getMimeType() - Method in interface com.streamsets.pipeline.api.RawSourcePreviewer
-
Returns the MIME type of the raw data.
- getName() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- getName() - Method in class com.streamsets.pipeline.api.Config
-
Returns the name of the configuration.
- getName() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Element
-
Returns the element name.
- getName() - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
The node value.
- getName() - Method in interface com.streamsets.pipeline.api.Stage.Info
-
Returns the name of the stage.
- getNames() - Method in interface com.streamsets.pipeline.api.credential.ManagedCredentialStore
-
Returns a list of all reference names in the credential store
- getNamespace() - Method in class com.streamsets.pipeline.api.BlobStoreDef
- getNeedGatewayAuth() - Method in interface com.streamsets.pipeline.api.gateway.GatewayInfo
-
Return true to use protected Data Collector URL "http://localhost:18630/rest/v1/gateway/
.". - getNumberOfThreads() - Method in class com.streamsets.pipeline.api.base.configurablestage.DPushSource
- getNumberOfThreads() - Method in interface com.streamsets.pipeline.api.PushSource
-
Returns the ideal number of threads that the source would like to run.
- getOffset() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
The offset of the results.
- getOffset() - Method in exception com.streamsets.pipeline.api.ext.io.ObjectLengthException
- getOffset() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataParser
-
Return offset in the stream (how many bytes were read until now).
- getOnErrorRecord() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns the configured error handling for the stage.
- getOutputLanes() - Method in interface com.streamsets.pipeline.api.Processor.Context
-
Returns the output lane names (stream names) of the
Source
. - getOutputLanes() - Method in interface com.streamsets.pipeline.api.ProtoSource.Context
-
Returns the output lane names (stream names) of the
Source
. - getParallelism() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- getParameters() - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
Method that feeds the names of the necessary runtime parameters needed to serialize/deserialize, as specified in the field annotations.
- getParameters() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.BaseContext
-
Parameters that were generated for this pipeline.
- getParams() - Method in exception com.streamsets.pipeline.api.StageException
-
Returns the error parameters of the exception.
- getParentField() - Method in interface com.streamsets.pipeline.api.RecordField
-
Parent field of the field that the cursor is currently pointing to, if applicable.
- getParentFieldPath() - Method in interface com.streamsets.pipeline.api.RecordField
-
Path of the parent field of the field that the cursor is currently pointing to, if applicable.
- getParents(String) - Method in class com.streamsets.pipeline.api.ExplorerSchema
-
Returns a list with the parents of a given element, in order from the top.
- getParser(File, String) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, byte[]) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, byte[], int, int) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, InputStream, String) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, Reader) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, Reader, long) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, String) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getParser(String, Map<String, Object>, FileRef) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
- getPattern(Map<String, Object>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
Provides the pattern to use to serialize/deserialize one field based on its annotations.
- getPermalink() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - Permalink
- getPipelineConstants() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Return pipeline constants.
- getPipelineDataCollectorId() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - DataCollectorId
- getPipelineId() - Method in interface com.streamsets.pipeline.api.gateway.GatewayInfo
-
Return Pipeline ID of the Microservice Pipeline
- getPipelineId() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Return unique id that identifies this pipeline.
- getPipelineId() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - PipelineId
- getPipelineId() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Return unique id that identifies this pipeline.
- getPipelineInfo() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns a list with the
Stage.Info
of all stages in the pipeline. - getPipelineMaxMemory() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Deprecated.
- getPipelineStartTime() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - PipelineStartTime
- getPipelineTitle() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - PipelineTitle
- getPipelineUser() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - PipelineUser
- getPort() - Method in class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- getPos() - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- getPreviousTrackingId() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the previous tracking ID for the record.
- getProperties() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Gets the properties map.
- getPushSource() - Method in class com.streamsets.pipeline.api.base.configurablestage.DPushSource
- getRaw() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Return the original origin raw bytes for the record if available.
- getRawMimeType() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Return the MIME type of the original origin raw bytes for the record if available.
- getRecord() - Method in exception com.streamsets.pipeline.api.base.OnRecordErrorException
-
Getter for the record which caused the error.
- getRecord() - Method in interface com.streamsets.pipeline.api.RecordField
-
Return record associated with the field.
- getRecords() - Method in interface com.streamsets.pipeline.api.Batch
-
Returns an iterator with all the records in the batch for the current stage.
- getRecordsProduced() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
-
Return the no of records produced by this source
- getRemediationSteps() - Method in enum class com.streamsets.pipeline.api.base.Errors
- getRemediationSteps() - Method in interface com.streamsets.pipeline.api.ErrorCode
- getResourceBundle() - Method in class com.streamsets.pipeline.api.base.BaseEnumChooserValues
- getResourceBundle() - Method in interface com.streamsets.pipeline.api.ChooserValues
-
Returns the name of the resource bundle to get the localized labels for the values.
- getResourceBundle() - Method in class com.streamsets.pipeline.api.ConnectionDef.Constants.ConnectionChooserValues
- getResourcesDirectory() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Returns the absolute path to the SDC resources directory.
- getResponseRecords() - Method in interface com.streamsets.pipeline.api.SourceResponseSink
-
Origins can use getResponseRecords to retrieve responses added by processors and destinations during the processing of the batch.
- getRoot() - Method in class com.streamsets.pipeline.api.ExplorerSchema
-
Returns the schema definition.
- getRunnerCount() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Get the number of runners that were created for this pipeline.
- getRunnerId() - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.Context
-
Get integer representing runner id - a value that doesn't change for given stage as it's executed in different threads.
- getSchema(Class) - Static method in class com.streamsets.pipeline.api.ExplorerSchema
-
Instantiates the schema of the given stage.
- getSchemaElement() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
The schema element being search.
- getSdcId() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Return unique id that identifies this data collector.
- getSdcId() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Return unique id that identifies this data collector.
- getSearch() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
RSQL expression (using schema elements as RSQL selectors) to search within the search domain.
- getSecret() - Method in interface com.streamsets.pipeline.api.gateway.GatewayInfo
-
Return the Gateway secret to use in the HTTP request header.
- getService(Class<? extends T>) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns singleton instance of given service configured especially for this stage instance.
- getServiceName() - Method in interface com.streamsets.pipeline.api.gateway.GatewayInfo
-
Return the service name for the API Gateway, used in the gateway rest point URL.
- getServiceUrl() - Method in interface com.streamsets.pipeline.api.gateway.GatewayInfo
-
Return the REST Service API Endpoint.
- getSource() - Method in class com.streamsets.pipeline.api.base.configurablestage.DSource
- getSourceEntity() - Method in interface com.streamsets.pipeline.api.Batch
-
Returns source's entity that was used to generate data for this batch.
- getSourceId() - Method in interface com.streamsets.pipeline.api.Record.Header
- getSourceOffset() - Method in interface com.streamsets.pipeline.api.Batch
-
Returns the initial offset of the current batch.
- getSourceResponseRecords() - Method in interface com.streamsets.pipeline.api.BatchContext
-
Returns list of records marked as Source Response
- getSpecificAttribute(LineageSpecificAttribute) - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Getter for a specificAttribute.
- getSpecificAttributes() - Method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- getStage() - Method in class com.streamsets.pipeline.api.base.configurablestage.DStage
- getStageBehaviorFlags() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.Context
-
Return set of Stage's behavior flags.
- getStageCreator() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the name of the stage instance that created the record.
- getStageDef() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.Context
-
Return StageDef of the stage.
- getStageInfo() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns a
Stage.Info
of this stage. - getStageInstance() - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Stage instance name (identifies instance of this stage in particular pipeline).
- getStageInstanceName() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Return unique id of stage that this interceptor is associated with.
- getStageInstanceName() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.Context
-
Return unique id of stage that this interceptor is associated with.
- getStageName() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - StageName
- getStageName() - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Stage name (identifies this stage uniquely in SDC)
- getStageRunnerSharedMap() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Returns concurrent hash map that is shared by all instances of this particular stage across all pipeline runners.
- getStagesPath() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the stages the record went through.
- getStageType() - Method in interface com.streamsets.pipeline.api.interceptor.InterceptorCreator.Context
-
Returns type of the stage for which the create() method is called.
- getStreamOffset() - Method in exception com.streamsets.pipeline.api.ext.io.OverrunException
- getStreamSetsConfigDir() - Method in interface com.streamsets.pipeline.api.credential.CredentialStore.Context
-
Returns StreamSets Configuration directory path.
- getStringBuilderPoolSize() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Deprecated.
- getSummary() - Method in class com.streamsets.pipeline.api.AntennaDoctorMessage
- getSupportedStreamClasses() - Method in class com.streamsets.pipeline.api.FileRef
-
Defines the supported stream classes for this
FileRef
. - getTags() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Retrieves the tags.
- getTechnicalErrorMessage() - Method in enum class com.streamsets.pipeline.api.base.Errors
- getTechnicalErrorMessage() - Method in interface com.streamsets.pipeline.api.ErrorCode
- getText() - Method in class com.streamsets.pipeline.api.PlaceholderBean
- getTimer(String) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Gets the already created
Timer
namespaced with the pipeline name and the stage instance name plus the given name. - getTimeStamp() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
fetch general parameter - event timestamp
- getToVersion() - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Desired target version after upgrade.
- getTrackingId() - Method in interface com.streamsets.pipeline.api.Record.Header
-
Returns the tracking ID for the record.
- getType() - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
The schema element name.
- getType() - Method in class com.streamsets.pipeline.api.Field
-
Returns the type of the field.
- getUnparsedRecord() - Method in exception com.streamsets.pipeline.api.service.dataformats.RecoverableDataParserException
- getUser() - Method in interface com.streamsets.pipeline.api.Stage.UserContext
-
Return username of the user who started this pipeline or job.
- getUserContext() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Return user context associated with currently running pipeline.
- getValue() - Method in class com.streamsets.pipeline.api.Config
-
Returns the value of the configuration.
- getValue() - Method in class com.streamsets.pipeline.api.Field
-
Returns the value of the field.
- getValue() - Method in interface com.streamsets.pipeline.api.lineage.ExtendedPropertyValue
-
Returns the String representation of the property.
- getValue() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueList
- getValue() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueString
- getValue() - Method in enum class com.streamsets.pipeline.api.StageTags
- getValueAsBoolean() - Method in class com.streamsets.pipeline.api.Field
-
Returns the boolean value of the field.
- getValueAsByte() - Method in class com.streamsets.pipeline.api.Field
-
Returns the byte value of the field.
- getValueAsByteArray() - Method in class com.streamsets.pipeline.api.Field
-
Returns the byte array value of the field.
- getValueAsChar() - Method in class com.streamsets.pipeline.api.Field
-
Returns the char value of the field.
- getValueAsDate() - Method in class com.streamsets.pipeline.api.Field
-
Returns the Date value of the field.
- getValueAsDatetime() - Method in class com.streamsets.pipeline.api.Field
-
Returns the Date value of the field.
- getValueAsDecimal() - Method in class com.streamsets.pipeline.api.Field
-
Returns the BigDecimal value of the field.
- getValueAsDouble() - Method in class com.streamsets.pipeline.api.Field
-
Returns the double value of the field.
- getValueAsFileRef() - Method in class com.streamsets.pipeline.api.Field
-
Returns the
FileRef
value of the field. - getValueAsFloat() - Method in class com.streamsets.pipeline.api.Field
-
Returns the float value of the field.
- getValueAsInteger() - Method in class com.streamsets.pipeline.api.Field
-
Returns the int value of the field.
- getValueAsList() - Method in class com.streamsets.pipeline.api.Field
-
Returns the List value of the field.
- getValueAsListMap() - Method in class com.streamsets.pipeline.api.Field
-
Returns the ordered Map value of the field.
- getValueAsLong() - Method in class com.streamsets.pipeline.api.Field
-
Returns the long value of the field.
- getValueAsMap() - Method in class com.streamsets.pipeline.api.Field
-
Returns the Map value of the field.
- getValueAsShort() - Method in class com.streamsets.pipeline.api.Field
-
Returns the short value of the field.
- getValueAsString() - Method in class com.streamsets.pipeline.api.Field
-
Returns the String value of the field.
- getValueAsTime() - Method in class com.streamsets.pipeline.api.Field
-
Returns the Date value of the field.
- getValueAsZonedDateTime() - Method in class com.streamsets.pipeline.api.Field
-
Returns value of the Field as a ZonedDateTime.
- getValues() - Method in class com.streamsets.pipeline.api.base.BaseEnumChooserValues
- getValues() - Method in interface com.streamsets.pipeline.api.ChooserValues
-
Returns the list of available values to choose from.
- getValues() - Method in class com.streamsets.pipeline.api.ConnectionDef.Constants.ConnectionChooserValues
- getVariable(String) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Returns the variable value.
- getVariablesInScope() - Static method in class com.streamsets.pipeline.api.el.ELEval
-
Returns the
ELVars
in scope while an EL is being evaluated. - getVersion() - Method in class com.streamsets.pipeline.api.BlobStoreDef
- getVersion() - Method in interface com.streamsets.pipeline.api.Stage.Info
-
Returns the version of the stage.
- GROOVY - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- group() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef
-
The configuration group for the UI.
- group() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The configuration group for the UI.
- groups() - Element in annotation interface com.streamsets.pipeline.api.ConfigDefBean
-
Allows to redefine the groups available to the configurations of the configuration bean.
- GROUPS_SECRET_SUFFIX - Static variable in interface com.streamsets.pipeline.api.credential.CredentialStore
H
- handleIOException(IOException) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Handle any IOExceptions thrown.
- has(String) - Method in interface com.streamsets.pipeline.api.Record
-
Indicates if the specified field-path has a
Field
or not. - hasContextVariable(String) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Indicates if a context variable is defined or not.
- hashCode() - Method in class com.streamsets.pipeline.api.Field
-
Returns the hashcode of the field.
- hashCode() - Method in class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- hasNext() - Method in interface com.streamsets.pipeline.api.FieldBatch
- hasVariable(String) - Method in interface com.streamsets.pipeline.api.el.ELVars
-
Indicates if a variable is defined or not.
- HBASE - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- HDFS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- HDFS - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
- healthCheck() - Method in interface com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService
-
Checks the SSH tunnel health throwing a StageException if unhealthy.
- hidden() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates whether the UI should show this stage in the palette or not.
- HideConfigs - Annotation Interface in com.streamsets.pipeline.api
-
Annotation to hide stage configurations in the UI.
- HideStage - Annotation Interface in com.streamsets.pipeline.api
-
Annotation to mark stage that should not be displayed on the pipeline canvas.
- HideStage.Type - Enum Class in com.streamsets.pipeline.api
-
Type of the hidden stage declaring where else the stage should be used in StreamSets infrastructure.
- HIVE - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- HIVE - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
- HostPort(String, int) - Constructor for class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- HTTP - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- HTTP - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- HTTP - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
I
- icon() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the UI icon for the stage.
- IMPLICIT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Evaluation
- implicitOnly() - Element in annotation interface com.streamsets.pipeline.api.ElFunction
-
Defines the EL function can only be used in implicit configurations.
- inErrorState() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
-
Return true if a unrecoverable error has occured
- init() - Method in class com.streamsets.pipeline.api.base.BaseService
-
Initializes the stage.
- init() - Method in class com.streamsets.pipeline.api.base.BaseStage
-
Initializes the stage.
- init() - Method in class com.streamsets.pipeline.api.base.SingleLaneProcessor
-
Performs the
SingleLaneProcessor
required initialization. - init() - Method in class com.streamsets.pipeline.api.ConnectionVerifier
- init() - Method in class com.streamsets.pipeline.api.interceptor.BaseInterceptor
-
Initializes the interceptor.
- init(CredentialStore.Context) - Method in interface com.streamsets.pipeline.api.credential.CredentialStore
-
Initializes the credential store.
- init(Interceptor.Context) - Method in class com.streamsets.pipeline.api.interceptor.BaseInterceptor
-
Initialize the interceptor.
- init(Interceptor.Context) - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor
-
Initializes the interceptor.
- init(LineagePublisher.Context) - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher
-
Initializes the publisher.
- init(Service.Context) - Method in class com.streamsets.pipeline.api.base.BaseService
-
Initializes the service.
- init(Service.Context) - Method in interface com.streamsets.pipeline.api.service.Service
-
Initializes the service..
- init(Stage.Info, C) - Method in class com.streamsets.pipeline.api.base.BaseStage
-
Initializes the stage.
- init(Stage.Info, C) - Method in class com.streamsets.pipeline.api.base.configurablestage.DStage
- init(Stage.Info, C) - Method in interface com.streamsets.pipeline.api.Stage
-
Initializes the stage.
- init(ProcessingEnvironment) - Method in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- initConnection() - Method in class com.streamsets.pipeline.api.ConnectionVerifier
-
Verifies the Connection's configuration.
- initLoader(Stage.Info, Stage.Context) - Method in interface com.streamsets.pipeline.api.ExplorerLoader
-
Initializes the loader using the stage configuration.
- initSearcher(Stage.Info, Stage.Context) - Method in interface com.streamsets.pipeline.api.ExplorerSearcher
-
Initializes the search.
- inputStreams() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates an enum (implementing
Label
) that defines the input stream names and UI labels for the stage. - INTEGER - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- intercept(List<Record>) - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor
-
Intercept records and perform operations that need to be performed.
- Interceptor - Interface in com.streamsets.pipeline.api.interceptor
-
Interceptor is a plugable component similar to Stage.
- Interceptor.Context - Interface in com.streamsets.pipeline.api.interceptor
-
Context that provides runtime information and services to the interceptor.
- InterceptorCreator - Interface in com.streamsets.pipeline.api.interceptor
-
Interceptor creator is used to create instance of interceptor for stages where they are required.
- InterceptorCreator.BaseContext - Interface in com.streamsets.pipeline.api.interceptor
-
Base context class that contains information and services to the creator without any association to the underlying stage.
- InterceptorCreator.Context - Interface in com.streamsets.pipeline.api.interceptor
-
Context that provides runtime information and services to the creator.
- InterceptorCreator.InterceptorType - Enum Class in com.streamsets.pipeline.api.interceptor
-
Type of the interceptor represents where exactly is the interceptor going to be executed.
- InterceptorDef - Annotation Interface in com.streamsets.pipeline.api.interceptor
- INTERCEPTORS_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- InterfaceAudience - Class in com.streamsets.pipeline.api
-
Annotation to inform users of a package, class or method's intended audience.
- InterfaceAudience.LimitedPrivate - Annotation Interface in com.streamsets.pipeline.api
-
Intended only for professional services consultants.
- InterfaceAudience.Private - Annotation Interface in com.streamsets.pipeline.api
-
Intended for use only within SDC itself.
- InterfaceAudience.Public - Annotation Interface in com.streamsets.pipeline.api
-
Intended for use by any project or application.
- InterfaceStability - Class in com.streamsets.pipeline.api
-
Annotation to inform users of how much to rely on a particular package, class or method not changing over time.
- InterfaceStability() - Constructor for class com.streamsets.pipeline.api.InterfaceStability
- InterfaceStability.Evolving - Annotation Interface in com.streamsets.pipeline.api
-
Evolving, but can break compatibility at minor release (i.e.
- InterfaceStability.Stable - Annotation Interface in com.streamsets.pipeline.api
-
Can evolve while retaining compatibility for minor release boundaries.; can break compatibility only at major release (ie.
- InterfaceStability.Unstable - Annotation Interface in com.streamsets.pipeline.api
-
No guarantee is provided as to reliability or stability across any level of release granularity.
- InvalidFieldPathException - Exception in com.streamsets.pipeline.api
-
Exception thrown a field path cannot be parsed.
- InvalidFieldPathException(String) - Constructor for exception com.streamsets.pipeline.api.InvalidFieldPathException
- InvalidFieldPathException(String, Throwable) - Constructor for exception com.streamsets.pipeline.api.InvalidFieldPathException
- isEmpty(String) - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
Utility method to check if some string has no actual value.
- isEnabled() - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- isEnabled() - Method in interface com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService
-
Returns if SSH tunneling is enabled or not.
- isErrorStage() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Indicates if this stage is used to handle errors in the pipeline.
- isFrameworkOnly() - Method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- isInBatchMode() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- isLeaf() - Method in interface com.streamsets.pipeline.api.lineage.ExtendedPropertyValue
-
Indicates whether the property is a leaf node.
- isLeaf() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueList
- isLeaf() - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueString
- isOneOf(Field.Type...) - Method in enum class com.streamsets.pipeline.api.Field.Type
- isOneOf(LineageEventType...) - Method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- isOneOf(StageType...) - Method in enum class com.streamsets.pipeline.api.StageType
- isPlainTextCompatible() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Returns true if the generated data are plain text (e.g.
- isPreview() - Method in interface com.streamsets.pipeline.api.interceptor.Interceptor.Context
-
Indicates if the pipeline is running in preview mode or not.
- isPreview() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Indicates if the pipeline is running in preview mode or not.
- isStopped() - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Indicates if the pipeline has been stopped while the stage is processing a batch of records.
- isUpTruncate() - Method in interface com.streamsets.pipeline.api.ExplorerSearcher.SearchRequest
-
It will truncate the result tree, from root down to the schema element being searched.
- isValidJson(String) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Decoides whether a given string is a valid JSON.
- isWholeFileChecksumRequired() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Returns true if the caller should generate checksum information for the whole file transfer.
- isWholeFileFormat() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Return true if and only if this service is configured to work with whole file record rather then normal records.
- isWholeFileFormat() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Return true if and only if this service is configured to output whole file record rather then normally parsed records.
J
- JAVA - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- JAVASCRIPT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- JDBC - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- JDBC - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
- JDBC - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- JDBC - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- JMS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- JSON - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- JsonDelegate<T> - Interface in com.streamsets.pipeline.api.ext.json
-
A Json delegate is an agent that can be injected into a Json (Jackson) serializer/deserializer to alter the way a field is serialized/deserialized.
- JsonDelegate.Parameters - Class in com.streamsets.pipeline.api.ext.json
-
System-wide runtime parameters.
- JsonException - Exception in com.streamsets.pipeline.api.ext.json
-
Dedicated exception for tasks directly linked to JSON serialization and deserialization.
- JsonException(String) - Constructor for exception com.streamsets.pipeline.api.ext.json.JsonException
-
Common constructor providing a message.
- JsonException(String, Throwable) - Constructor for exception com.streamsets.pipeline.api.ext.json.JsonException
-
Common constructor providing a message and a reason.
- JsonIncluded - Annotation Interface in com.streamsets.pipeline.api.ext.json
-
Mandatory annotation to indicate json serializer and deserializer which fields to include in the serialization and deserialization process.
- JsonMapper - Interface in com.streamsets.pipeline.api.ext.json
-
Facade for a bidirectional Json-Object mapper.
- JsonModel - Interface in com.streamsets.pipeline.api.ext.json
-
An interface abstraction basic functionality on a JSON tree.
- JsonRule - Annotation Interface in com.streamsets.pipeline.api.ext.json
- JsonRule.Format - Enum Class in com.streamsets.pipeline.api.ext.json
- JsonRule.Strategy - Enum Class in com.streamsets.pipeline.api.ext.json
- JsonRuleParameter - Annotation Interface in com.streamsets.pipeline.api.ext.json
K
- KAFKA - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- key() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRuleParameter
- KINESIS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- KINESIS - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- KINESIS - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- KOTLIN - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- KUDU - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
L
- label() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef
-
The default label for the UI.
- label() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The default label for the UI.
- label() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
A user-facing label or name for this Connection Definition.
- label() - Element in annotation interface com.streamsets.pipeline.api.credential.CredentialStoreDef
-
Indicates the UI default label for the credential store.
- label() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
- label() - Element in annotation interface com.streamsets.pipeline.api.lineage.LineagePublisherDef
-
Indicates the UI default label for the publisher.
- label() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Indicates the UI default label for the stage.
- label() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the UI default label for the stage.
- Label - Interface in com.streamsets.pipeline.api
-
Interface used by stage enums used in the configuration to provide the default UI label for the enums.
- latestVersion(String, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Return latest version for given object.
- libJarsRegex() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates an array of regex patterns of the stage library JARs that must be used for the slave Data Collectors at bootstrap time.
- LIFECYCLE_STAGE - Enum constant in enum class com.streamsets.pipeline.api.HideStage.Type
-
Lifecycle stage can be used in the pipeline start and stop even handlers.
- LINEAGE_PUBLISHERS_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- LineageEvent - Interface in com.streamsets.pipeline.api.lineage
- LineageEventType - Enum Class in com.streamsets.pipeline.api.lineage
- LineageLogicalEndPointTypes - Enum Class in com.streamsets.pipeline.api.lineage
- LineagePhysicalEndPointTypes - Enum Class in com.streamsets.pipeline.api.lineage
- LineagePublisher - Interface in com.streamsets.pipeline.api.lineage
-
Data collectors collects various lineage metadata for all pipelines while they are running.
- LineagePublisher.ConfigIssue - Interface in com.streamsets.pipeline.api.lineage
-
Interface for configuration issues.
- LineagePublisher.Context - Interface in com.streamsets.pipeline.api.lineage
-
LineagePublisher Context that provides runtime information and services to the plugin.
- LineagePublisherDef - Annotation Interface in com.streamsets.pipeline.api.lineage
- LineageSpecificAttribute - Enum Class in com.streamsets.pipeline.api.lineage
-
These are specific attributes - each LineageEventType needs a subset of these...
- lines() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates the number of lines in the UI for configuration variables of type
ConfigDef.Type.TEXT
. - LIST - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- LIST - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- LIST_MAP - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- LIST_MULTI_VALUE - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
- ListBeanModel - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for configuration variables that can hold a list of a configuration bean.
- loadData() - Method in interface com.streamsets.pipeline.api.ExplorerLoader
-
Loads explorer data to be used by the corresponding
ExplorerSearcher
for searchers, it replaces the previous one. - loadValue(byte[]) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Produces a model (JSON tree) from an array of bytes, ready to traverse, investigate and manipulate.
- loadValue(String) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Produces a model (JSON tree) from a string, ready to traverse, investigate and manipulate.
- LOCAL_DATE_TIME - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
- LOCAL_FS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- LocalDateTimeDelegate - Class in com.streamsets.pipeline.api.ext.json.delegate
-
JSON Delegate used to produce Human-readable strings from LocalDateTime objects.
- LocalDateTimeDelegate(JsonRule) - Constructor for class com.streamsets.pipeline.api.ext.json.delegate.LocalDateTimeDelegate
- LocalDateTimeDelegate.Parameters - Interface in com.streamsets.pipeline.api.ext.json.delegate
- localIdleCall(Callable<T>, String, Object...) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Deprecated.
- localIdleCall(Callable<T>, Function<T, Boolean>, String, Object...) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Invokes the given Callable stopping the local execution timer.
- location() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
Where Explorer UI should set the Explorer chosen value in the configuration.
- LogParserService - Interface in com.streamsets.pipeline.api.service.dataformats.log
-
Service for parsing logs from input streams
- LONG - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
M
- MANAGED_TABULAR - Enum constant in enum class com.streamsets.pipeline.api.StageDef.ExplorerSearchType
- ManagedCredentialStore - Interface in com.streamsets.pipeline.api.credential
- MAP - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- MAP - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- MAP_KEY - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
- MAP_VALUE - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
- MARIADB - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- MARIADB - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- mark(int) - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- mark(int) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
mark(int)
method. - markSupported() - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
markSupported()
method. - max() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates the maximum value for configuration variables of type
ConfigDef.Type.NUMBER
. - MD5 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- MetricContext - Interface in com.streamsets.pipeline.api
- MICROSOFT - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- MICROSOFT - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- mimeType() - Element in annotation interface com.streamsets.pipeline.api.RawSource
-
Indicates the MIME type of the raw data, for UI syntax highlighting.
- min() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates the minimum value for configuration variables of type
ConfigDef.Type.NUMBER
. - missingSpecificAttributes() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Provides a list of all the specific attributes associated with this Lineage Event type which are not set.
- mode() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates the expected syntax for a configuration of type
ConfigDef.Type.TEXT
. - Mode - Enum Class in com.streamsets.pipeline.api.ext.json
- MODEL - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
-
If a configuration variable is defined as
Model
, the variable must also be annotated with a model annotation. - MULTIPLE_OBJECTS - Enum constant in enum class com.streamsets.pipeline.api.ext.json.Mode
- MultiValueChooserModel - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for configuration variables that can hold multiple values from a given list of values.
- MURMUR3_128 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- MURMUR3_32 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- MYSQL - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- MYSQL - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
N
- name() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef.Config
-
Config name.
- name() - Element in annotation interface com.streamsets.pipeline.api.ElConstant
-
Constant name to be used within ELs.
- name() - Element in annotation interface com.streamsets.pipeline.api.ElFunction
-
Function name to be used within ELs.
- name() - Element in annotation interface com.streamsets.pipeline.api.EventFieldDef
-
Field Name
- name() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRuleParameter
- name() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceConfiguration
-
Name of the configuration that needs to be injected.
- next() - Method in interface com.streamsets.pipeline.api.FieldBatch
-
Move the cursor to next field.
- nextExplorer() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
Next explorer ID, for UI navigation purposes.
- NO - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Upload
- NONE - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
A configuration that has a schema element only to be used to fix schema elements in explorer searches.
- NONE - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
- NONE - Static variable in class com.streamsets.pipeline.api.ExplorerData
-
An Empty explorer DATA.
- NONE() - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.NONE
- NUMBER - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- numberOfInputStreams() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Specifies the number of input lanes that this stage supports.
O
- ObjectLengthException - Exception in com.streamsets.pipeline.api.ext.io
- ObjectLengthException(String, long) - Constructor for exception com.streamsets.pipeline.api.ext.io.ObjectLengthException
- offsetCommitter - Variable in class com.streamsets.pipeline.api.base.configurablestage.DSourceOffsetCommitter
- offsetCommitter - Variable in class com.streamsets.pipeline.api.base.configurablestage.DTargetOffsetCommitTrigger
- OffsetCommitter - Interface in com.streamsets.pipeline.api
-
Source
s that keep track of the data offset on their own should implement this interface. - OffsetCommitTrigger - Interface in com.streamsets.pipeline.api
-
Target
s that trigger offset commit should implement this interface. - onErrorRecord() - Element in annotation interface com.streamsets.pipeline.api.HideConfigs
-
Hides system defined 'on error record' configuration from the UI.
- onlineHelpRefUrl() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Relative path to online help for this stage.
- OnRecordError - Enum Class in com.streamsets.pipeline.api
-
Enumeration defining the error record handling for stages via the built-in 'on record error' configuration.
- OnRecordErrorException - Exception in com.streamsets.pipeline.api.base
-
Exception a stage can throw when a specific record should go to the error pipeline.
- OnRecordErrorException(ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.base.OnRecordErrorException
-
Class constructor specifying the error code and any parameters to be interpolated into the error message.
- OnRecordErrorException(Record, ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.base.OnRecordErrorException
-
Optional class constructor which also specifies the record in error.
- optional() - Element in annotation interface com.streamsets.pipeline.api.EventFieldDef
-
Indicates if a field is optional or not.
- ORACLE - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- ORACLE - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- OTHER - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- OTHER - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
- OTHER - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
- OUTPUT - Enum constant in enum class com.streamsets.pipeline.api.StageDef.DefaultOutputStreams
- outputStreams() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates an enum (implementing
Label
) that defines the output streams names and UIL labels for the stage. - outputStreamsDrivenByConfig() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
If the number of output streams is driven a stage configuration (it must be a
List
), the name of the configuration must be indicated here. - OverrunException - Exception in com.streamsets.pipeline.api.ext.io
- OverrunException(String, long) - Constructor for exception com.streamsets.pipeline.api.ext.io.OverrunException
- OverrunException(String, long, Throwable) - Constructor for exception com.streamsets.pipeline.api.ext.io.OverrunException
- OverrunReader - Class in com.streamsets.pipeline.api.ext.io
-
Caps amount of data read to avoid OOM issues, max size should be 64K or more ot avoid issues with implicit stream buffers by JDK and libraries.
- OverrunReader(Reader, int, boolean, boolean) - Constructor for class com.streamsets.pipeline.api.ext.io.OverrunReader
- OVERWRITE - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileExistsAction
P
- parameters() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRule
- Parameters() - Constructor for class com.streamsets.pipeline.api.ext.json.JsonDelegate.Parameters
- parse() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataParser
-
Parse next record.
- parseAll() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataParser
-
Parse all records from the stream.
- parseEL(String) - Method in interface com.streamsets.pipeline.api.ProtoConfigurableEntity.ELContext
-
Validates an EL is syntactically correct.
- PASSTHROUGH - Enum constant in enum class com.streamsets.pipeline.api.StageBehaviorFlags
- pattern() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRule
- PATTERN - Static variable in class com.streamsets.pipeline.api.ext.json.JsonDelegate.Parameters
- PIPELINE - Enum constant in enum class com.streamsets.pipeline.api.StageType
- PipelineAnnotationsProcessor - Class in com.streamsets.pipeline.api.impl.annotationsprocessor
- PipelineAnnotationsProcessor() - Constructor for class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- PipelineLifecycleStage - Annotation Interface in com.streamsets.pipeline.api
- placeholder() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The placeholder for the UI.
- Placeholder - Annotation Interface in com.streamsets.pipeline.api
- PlaceholderBean - Class in com.streamsets.pipeline.api
- PlaceholderBean() - Constructor for class com.streamsets.pipeline.api.PlaceholderBean
-
Constructor necessary for Jackson
- PlaceholderBean(Placeholder) - Constructor for class com.streamsets.pipeline.api.PlaceholderBean
-
Constructor for the placeholder bean.
- PLAIN_TEXT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- POLL_SOURCE_OFFSET_KEY - Static variable in interface com.streamsets.pipeline.api.Source
-
Data collector is using a Map<String, String> to keep track of offsets.
- POST_STAGE - Enum constant in enum class com.streamsets.pipeline.api.interceptor.InterceptorCreator.InterceptorType
- postDestroy() - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
- POSTGRESQL - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- POSTGRESQL - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- PRE_STAGE - Enum constant in enum class com.streamsets.pipeline.api.interceptor.InterceptorCreator.InterceptorType
- preconditions() - Element in annotation interface com.streamsets.pipeline.api.HideConfigs
-
Hides system defined 'required fields' and preconditions configurations from the UI.
- PredicateModel - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for configuration variables that define predicate/lane(output-streams) pairs.
- prefix() - Element in annotation interface com.streamsets.pipeline.api.ElFunction
-
Function prefix to be used within ELs.
- preview(int) - Method in interface com.streamsets.pipeline.api.RawSourcePreviewer
-
Returns the
InputStream
containing raw data for preview. - privateClassLoader() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Indicates each stage instance should use a private classloader.
- privateClassLoader() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates each stage instance should use a private classloader.
- process(Batch, SingleLaneProcessor.SingleLaneBatchMaker) - Method in class com.streamsets.pipeline.api.base.SingleLaneProcessor
-
When running a pipeline, this method is called to process a batch of records.
- process(Batch, SingleLaneProcessor.SingleLaneBatchMaker) - Method in class com.streamsets.pipeline.api.base.SingleLaneRecordProcessor
-
Processes the batch by calling the
SingleLaneRecordProcessor.process(Record, SingleLaneBatchMaker)
method for each record in the batch. - process(Batch, BatchMaker) - Method in class com.streamsets.pipeline.api.base.BaseFieldProcessor
- process(Batch, BatchMaker) - Method in class com.streamsets.pipeline.api.base.configurablestage.DProcessor
- process(Batch, BatchMaker) - Method in class com.streamsets.pipeline.api.base.RecordProcessor
-
Processes the batch by calling the
RecordProcessor.process(Record, BatchMaker)
method for each record in the batch. - process(Batch, BatchMaker) - Method in class com.streamsets.pipeline.api.base.SingleLaneProcessor
-
Processes the batch by calling the
SingleLaneProcessor.process(Batch, SingleLaneBatchMaker)
method. - process(Batch, BatchMaker) - Method in interface com.streamsets.pipeline.api.Processor
-
When running a pipeline, the Data Collector calls this method from the
Processor
stage with a batch of records to process. - process(FieldBatch) - Method in interface com.streamsets.pipeline.api.FieldProcessor
-
Process given field batch.
- process(Record, SingleLaneProcessor.SingleLaneBatchMaker) - Method in class com.streamsets.pipeline.api.base.SingleLaneRecordProcessor
-
Processes one record.
- process(Record, BatchMaker) - Method in class com.streamsets.pipeline.api.base.RecordProcessor
-
Processes one record.
- process(Set<? extends TypeElement>, RoundEnvironment) - Method in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- processBatch(BatchContext) - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Process given batch - run it through rest of the pipeline.
- processBatch(BatchContext, String, String) - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Process given batch - run it through rest of the pipeline.
- ProcessedContext - Interface in com.streamsets.pipeline.api
-
Describes methods for various context classes that deals with error handling.
- Processor - Interface in com.streamsets.pipeline.api
-
A
Processor
is a Data Collector processor stage. - PROCESSOR - Enum constant in enum class com.streamsets.pipeline.api.StageType
- Processor.Context - Interface in com.streamsets.pipeline.api
-
Processor
stage context. - produce(String, int, BatchMaker) - Method in class com.streamsets.pipeline.api.base.configurablestage.DSource
- produce(String, int, BatchMaker) - Method in class com.streamsets.pipeline.api.ConnectionVerifier
- produce(String, int, BatchMaker) - Method in interface com.streamsets.pipeline.api.Source
-
When running a pipeline, the Data Collector calls this method from the
Source
stage to obtain a batch of records for processing. - produce(Map<String, String>, int) - Method in class com.streamsets.pipeline.api.base.configurablestage.DPushSource
- produce(Map<String, String>, int) - Method in interface com.streamsets.pipeline.api.PushSource
-
When a pipeline is initialized and prepared to run, the Data Collector calls this method to start the Source.
- PRODUCER - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- PRODUCER - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- producesEvents() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates if this stage can produce events.
- PROPERTIES - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- PROPERTY - Enum constant in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
- ProtoConfigurableEntity - Interface in com.streamsets.pipeline.api
-
Shared interface for all active configurable objects - such as Stage or Service.
- ProtoConfigurableEntity.Context - Interface in com.streamsets.pipeline.api
-
Context that provides runtime information and services to the stage.
- ProtoConfigurableEntity.ELContext - Interface in com.streamsets.pipeline.api
-
Context to create and use Java Expression Language (EL) evaluators.
- ProtoSource<C extends Stage.Context> - Interface in com.streamsets.pipeline.api
-
A
ProtoSource
is base for Data Collector origin stage. - ProtoSource.Context - Interface in com.streamsets.pipeline.api
-
Source
stage context. - provides() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Interface describing what methods this services provides.
- ProxyReader - Class in com.streamsets.pipeline.api.ext.io
-
Included from Apache commons A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.
- ProxyReader(Reader) - Constructor for class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Constructs a new ProxyReader.
- publishEvents(List<LineageEvent>) - Method in interface com.streamsets.pipeline.api.lineage.LineagePublisher
-
Process given list of events and push them to the lineage collector.
- publishLineageEvent(LineageEvent) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Publish given lineage event to configured lineage store.
- PURE_FUNCTION - Enum constant in enum class com.streamsets.pipeline.api.StageBehaviorFlags
- PushSource - Interface in com.streamsets.pipeline.api
- PushSource.Context - Interface in com.streamsets.pipeline.api
-
PushSource
stage context. - put(List<Map.Entry>) - Method in class com.streamsets.pipeline.api.base.configurablestage.DClusterSourceOffsetCommitter
-
Writes batch of data to the source
- PYTHON - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
R
- RawSource - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for Data Collector origin (
Source
) stages that provide a way to view the raw data they produce during preview mode. - rawSourcePreviewer() - Element in annotation interface com.streamsets.pipeline.api.RawSource
-
Indicates the implementation class providing raw preview capabilities.
- RawSourcePreviewer - Interface in com.streamsets.pipeline.api
- read() - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- read() - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
read()
method. - read(char[]) - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- read(char[]) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
read(char[])
method. - read(char[], int, int) - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- read(char[], int, int) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
read(char[], int, int)
method. - read(CharBuffer) - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- read(CharBuffer) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
read(CharBuffer)
method. - READ_LIMIT_SYS_PROP - Static variable in class com.streamsets.pipeline.api.ext.io.OverrunReader
- readValue(byte[], Class<T>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Deserializes an array of bytes onto an object.
- readValue(byte[], Class<T>, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Deserializes an array of bytes onto an object, using optional runtime parameters.
- readValue(Class<T>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonModel
-
Deserializes a tree onto a new object.
- readValue(Class<T>, Object) - Method in interface com.streamsets.pipeline.api.ext.json.JsonModel
-
Deserializes a tree onto an existing object.
- readValue(Class<T>, Object, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonModel
-
Deserializes a tree onto an existing object, using optional runtime parameters.
- readValue(Class<T>, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonModel
-
Deserializes a tree onto a new object, using optional runtime parameters.
- readValue(String, Class<T>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Deserializes a string onto an object.
- readValue(String, Class<T>, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Deserializes a string onto an object, using optional runtime parameters.
- ready() - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
ready()
method. - Record - Interface in com.streamsets.pipeline.api
-
A
Record
represents the unit of data Data Collector pipelines process. - Record.Header - Interface in com.streamsets.pipeline.api
-
Metadata of the record.
- RecordExecutor - Class in com.streamsets.pipeline.api.base
-
The
RecordExecutor
is an convenienceExecutor
that handles one record at the time (instead of batch) and has a built-in record error handling for the stage 'on record error' configuration. - RecordExecutor() - Constructor for class com.streamsets.pipeline.api.base.RecordExecutor
- RecordField - Interface in com.streamsets.pipeline.api
-
Record Field is a wrapper on top of field describing where the field is located (e.g.
- RecordProcessor - Class in com.streamsets.pipeline.api.base
-
The
RecordProcessor
is an convenienceProcessor
that handles one record at the time (instead of batch) and has a built-in record error handling for the stage 'on record error' configuration. - RecordProcessor() - Constructor for class com.streamsets.pipeline.api.base.RecordProcessor
- recordsByRef() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates that the stage will not touch records after they were passed down to the framework via BatchMaker.addRecord().
- RecordTarget - Class in com.streamsets.pipeline.api.base
-
The
RecordTarget
is an convenienceTarget
that handles one record at the time (instead of batch) and has a built-in record error handling for the stage 'on record error' configuration. - RecordTarget() - Constructor for class com.streamsets.pipeline.api.base.RecordTarget
- RecoverableDataParserException - Exception in com.streamsets.pipeline.api.service.dataformats
-
Thrown in case when the record can't be parsed, but the problem is not severe enough to invalidate the whole stream, e.g.
- RecoverableDataParserException(Record, ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.service.dataformats.RecoverableDataParserException
- registerApiGateway(GatewayInfo) - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Register API Gateway for given gateway info entity
- registerService(Class, List<Config>) - Method in interface com.streamsets.pipeline.api.StageUpgrader.Context
-
Register given service with provided configuration.
- reInitializeDefaultReadLimit() - Static method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- remoteIdleCall(Callable<T>, String, Object...) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Deprecated.
- remoteIdleCall(Callable<T>, Function<T, Boolean>, String, Object...) - Method in interface com.streamsets.pipeline.api.MetricContext
-
Invokes the given Callable stopping the remote execution timer.
- replace(Field) - Method in interface com.streamsets.pipeline.api.FieldOperator
-
Replace the field the cursor is currently pointing to with the replacement.
- reportError(ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Reports an error using a localizable error code and arguments for it.
- reportError(Exception) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Reports an
Exception
as an error. - reportError(String) - Method in interface com.streamsets.pipeline.api.Stage.Context
-
Reports an error using a non-localizable error message.
- required() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Indicates if a configuration value is required or not.
- requiredForExplorerLoad() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
If the stage uses explorer, set this property to TRUE to indicate the property is required for explorer to work (for example, it contains connection information required for explorer to retrieve data from the external system).
- reset() - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- reset() - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
reset()
method. - resetCount() - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- resetOffset() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates wheather stage (Origin) supports resetting offset
- REST - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- REST - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- retrieve(String, String, long) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Retrieve given object.
- retrieveLatest(String, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Convenience method to return latest version for given object.
- root() - Static method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
Creates an empty tree, just the root node.
- RUBY - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- RUNTIME - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
S
- S3 - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- S3 - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- S3 - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- SCALA - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- schemaElement() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
Name of the metadata explorer schema element Explorer UI should let the user select for this configuration.
- SdcEL - Class in com.streamsets.pipeline.api.el
-
Class defining the
sdc:id()
function. - SdcRecordGeneratorService - Interface in com.streamsets.pipeline.api.service.dataformats
-
Special data-format service that will always use SDC_RECORD as the output format and thus have no input parameters in the UI to configure.
- search(ExplorerData<T>, ExplorerSearcher.SearchRequest) - Method in interface com.streamsets.pipeline.api.ExplorerSearcher
-
Does a search on the given
ExplorerData
. - SELF - Enum constant in enum class com.streamsets.pipeline.api.StageDef.ExplorerSearchType
- sendsResponse() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates if this stage can send response back to caller.
- separator() - Element in annotation interface com.streamsets.pipeline.api.CompositeConfigDef.Config
-
Separator to use before the next config, default is an empty space.
- serialize(Class, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.ClassDelegate
- serialize(LocalDateTime, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.LocalDateTimeDelegate
- serialize(ZonedDateTime, Map<String, Object>) - Method in class com.streamsets.pipeline.api.ext.json.delegate.ZonedDateTimeDelegate
- serialize(T, Map<String, Object>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonDelegate
-
This method is invoked when one annotated field is marked as using this custom serialization procedure.
- service() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDependency
-
Interface defining the service.
- Service - Interface in com.streamsets.pipeline.api.service
-
Base interface for Data Collector services, a reusable and configurable code that stages can depend on to outsource and share common functionality.
- SERVICE_FOR_KAITAI_KEY - Static variable in interface com.streamsets.pipeline.api.ext.json.JsonMapper
- SERVICE_FOR_OFFSETS_KEY - Static variable in interface com.streamsets.pipeline.api.ext.json.JsonMapper
- SERVICE_KEY - Static variable in interface com.streamsets.pipeline.api.ext.json.JsonMapper
- Service.Context - Interface in com.streamsets.pipeline.api.service
-
LineagePublisher Context that provides runtime information and services to the plugin.
- ServiceConfiguration - Annotation Interface in com.streamsets.pipeline.api.service
-
Compile time configuration that a Stage needs to inject into declared Service dependency.
- ServiceDef - Annotation Interface in com.streamsets.pipeline.api.service
-
Annotation to declare Data Collector service classes.
- ServiceDependency - Annotation Interface in com.streamsets.pipeline.api.service
- services() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
List of services that this stage require for it's proper working.
- SERVICES_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- set(Field) - Method in interface com.streamsets.pipeline.api.Record
-
Sets the root data field of the record.
- set(String, Field) - Method in interface com.streamsets.pipeline.api.Record
-
Sets a
Field
in the specified field-path. - set(String, Field, boolean) - Method in interface com.streamsets.pipeline.api.Record
-
Sets a
Field
in the specified field-path. - Set(String, ExplorerSchema.Element, ExplorerSchema.Element...) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.Set
-
Creates a Set schema element with no icon and its children elements.
- Set(String, String, ExplorerSchema.Element, ExplorerSchema.Element...) - Constructor for class com.streamsets.pipeline.api.ExplorerSchema.Set
-
Creates a Set schema element with an icon and its children elements.
- setAntennaDoctorMessages(List<AntennaDoctorMessage>) - Method in exception com.streamsets.pipeline.api.StageException
- setAttribute(String, String) - Method in class com.streamsets.pipeline.api.Field
-
Sets an attribute.
- setAttribute(String, String) - Method in interface com.streamsets.pipeline.api.Record.Header
-
Sets an attribute.
- setAttributes(Map<String, String>) - Method in class com.streamsets.pipeline.api.Field
-
Sets all attributes from the given map.
- setChildren(List<Map<String, ExtendedPropertyValue>>) - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueList
- setContext(StageLibraryDelegate.Context) - Method in class com.streamsets.pipeline.api.delegate.BaseStageLibraryDelegate
- setContext(StageLibraryDelegate.Context) - Method in interface com.streamsets.pipeline.api.delegate.StageLibraryDelegate
-
Set context for the delegate.
- setEnabled(boolean) - Method in class com.streamsets.pipeline.api.ext.io.OverrunReader
- setExtendedProperties(Map<String, ExtendedPropertyValue>) - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Sets the extended properties.
- setMimeType(String) - Method in interface com.streamsets.pipeline.api.RawSourcePreviewer
-
Sets the MIME type of the raw data.
- setProperties(Map<String, String>) - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Sets the properties.
- setSpecificAttribute(LineageSpecificAttribute, String) - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Add a specificAttribute to the LineageEvent.
- setStringBuilderPoolSize(int) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Deprecated.
- setTags(List<String>) - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
Sets the tag array.
- setText(String) - Method in class com.streamsets.pipeline.api.PlaceholderBean
- setTruncated() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataParser
-
Indicate to the parse that a truncated input has been detected.
- setValue(String) - Method in class com.streamsets.pipeline.api.lineage.ExtendedPropertyValueString
- setVersion(long) - Method in class com.streamsets.pipeline.api.BlobStoreDef
- SHA1 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- SHA256 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- SHA512 - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
- SHELL - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- SHORT - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- SingleLaneProcessor - Class in com.streamsets.pipeline.api.base
-
The
SingleProcessor
is an convenienceProcessor
that handles writes all records to a single output stream. - SingleLaneProcessor() - Constructor for class com.streamsets.pipeline.api.base.SingleLaneProcessor
-
Constructor.
- SingleLaneProcessor.SingleLaneBatchMaker - Interface in com.streamsets.pipeline.api.base
-
Data Collector(
SingleLaneProcessor
) stages receive an instance of aSingleLaneBatchMaker
to write to the pipeline the records they create or process. - SingleLaneRecordProcessor - Class in com.streamsets.pipeline.api.base
-
The
SingleLaneRecordProcessor
is an convenienceProcessor
that handles one record at the time (instead of batch) and has a built-in record error handling for the stage 'on record error' and writes all records to a single output stream. - SingleLaneRecordProcessor() - Constructor for class com.streamsets.pipeline.api.base.SingleLaneRecordProcessor
- singleValued() - Element in annotation interface com.streamsets.pipeline.api.FieldSelectorModel
-
Indicates if the selection should be single value (default) or multi value.
- skip(long) - Method in class com.streamsets.pipeline.api.ext.io.CountingReader
- skip(long) - Method in class com.streamsets.pipeline.api.ext.io.ProxyReader
-
Invokes the delegate's
skip(long)
method. - SLAVE - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- SNOWFLAKE - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- SNOWFLAKE - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- SNOWPARK - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- source - Variable in class com.streamsets.pipeline.api.base.configurablestage.DSourceOffsetCommitter
- Source - Interface in com.streamsets.pipeline.api
-
A
Source
is Data Collector origin stage. - SOURCE - Enum constant in enum class com.streamsets.pipeline.api.StageType
- Source.Context - Interface in com.streamsets.pipeline.api
-
Source
stage context. - SourceResponseSink - Interface in com.streamsets.pipeline.api
-
A SourceResponseSink is used to pass responses from destinations or processors back to the origin about the batch that was processed.
- SQL - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Mode
- SQL - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- SQL - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- SQL_SERVER - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- SQL_SERVER - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- SQS - Enum constant in enum class com.streamsets.pipeline.api.lineage.EndPointType
- SQS - Enum constant in enum class com.streamsets.pipeline.api.StageTags
- SQS - Static variable in class com.streamsets.pipeline.api.StageTags.Constants
- SshTunnelService - Interface in com.streamsets.pipeline.api.service.sshtunnel
-
Service that provides SSH Tunnel support.
- SshTunnelService.HostPort - Class in com.streamsets.pipeline.api.service.sshtunnel
-
Host and port pair.
- Stage<C extends Stage.Context> - Interface in com.streamsets.pipeline.api
-
Internal Base interface for Data Collector stages implementations defining their common context and lifecycle.
- STAGE_DEF_LIST_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- Stage.ConfigIssue - Interface in com.streamsets.pipeline.api
-
Interface for configuration issues.
- Stage.Context - Interface in com.streamsets.pipeline.api
-
Stage Context that provides runtime information and services to the stage.
- Stage.Info - Interface in com.streamsets.pipeline.api
-
It provides information about the stage.
- Stage.UserContext - Interface in com.streamsets.pipeline.api
-
Context to get information about user that started the pipeline or job.
- StageBehaviorFlags - Enum Class in com.streamsets.pipeline.api
-
Various flags describing how given stage behaves that Data Collector framework can use when executing the flags.
- StageDef - Annotation Interface in com.streamsets.pipeline.api
-
Annotation to declare Data Collector stages classes.
- StageDef.DefaultInputStreams - Enum Class in com.streamsets.pipeline.api
-
Java doesn't allow null to be used in annotations, so this DefaultInputStream serves as a constant replacement for null - it's an empty enumeration and corresponds to situation when numberOfInputStreams() returns -1.
- StageDef.DefaultOutputStreams - Enum Class in com.streamsets.pipeline.api
-
Default enumeration used by stages having a single output stream.
- StageDef.ExplorerSearchType - Enum Class in com.streamsets.pipeline.api
-
The type of explorer search the stage has.
- StageDef.VariableOutputStreams - Enum Class in com.streamsets.pipeline.api
-
Enumeration to use in
StageDef.outputStreams()
to indicate that the output streams are variable, driven by the stage configuration specified inStageDef.outputStreamsDrivenByConfig()
. - StageException - Exception in com.streamsets.pipeline.api
-
Exception thrown by stages when there is an error while processing.
- StageException(ErrorCode, Object...) - Constructor for exception com.streamsets.pipeline.api.StageException
-
Exception constructor.
- StageLibraryDelegate - Interface in com.streamsets.pipeline.api.delegate
- StageLibraryDelegate.Context - Interface in com.streamsets.pipeline.api.delegate
-
Context that provides runtime information and services to the delegate.
- StageLibraryDelegateDef - Annotation Interface in com.streamsets.pipeline.api.delegate
-
Stage library delegate allows the data collector framework to "offload" certain core functionality into stage library to isolate dependencies of such functionality.
- STAGES_FILE - Static variable in class com.streamsets.pipeline.api.impl.annotationsprocessor.PipelineAnnotationsProcessor
- stageSuggestions() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
Set to true if the stage is able to generate custom suggestions for this field.
- StageTags - Enum Class in com.streamsets.pipeline.api
- StageTags.Constants - Class in com.streamsets.pipeline.api
- StageType - Enum Class in com.streamsets.pipeline.api
- StageUpgrader - Interface in com.streamsets.pipeline.api
-
The
StageUpgrader
allows stages to upgrade their configuration from previous versions of the stage. - StageUpgrader.Context - Interface in com.streamsets.pipeline.api
-
Upgrade context with various upgrade metadata.
- StageUpgrader.Default - Class in com.streamsets.pipeline.api
-
Default
StageUpgrader
implementation. - StageUpgrader.Error - Enum Class in com.streamsets.pipeline.api
-
Error codes used by the upgrader.
- StageUpgrader.ExtendedContext - Interface in com.streamsets.pipeline.api
-
Upgrade context with external upgrade metadata.
- STANDALONE - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- start(List<SshTunnelService.HostPort>) - Method in interface com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService
-
Starts the SSH tunnel and ports forwarding through the SSH tunnel if the configuration of the service indicates tunneling is enabled otherwise is a No-Op.
- START - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- startBatch() - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
Start new batch and return a context that allows source to create batch maker that can further be used to pass records for the rest of the pipeline to process.
- STATS_AGGREGATOR_STAGE - Enum constant in enum class com.streamsets.pipeline.api.HideStage.Type
-
Stats aggregation stages are used to send metrics from Data Collector to Control hub.
- StatsAggregatorStage - Annotation Interface in com.streamsets.pipeline.api
-
Used to define destination (
Target
) stages that accept aggregated pipeline statistics, i.e., pipeline metrics, data rule evaluation results and drift rule evaluation results. - stop() - Method in interface com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService
-
Stops the SSH tunnel.
- STOP - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageEventType
- STOP_PIPELINE - Enum constant in enum class com.streamsets.pipeline.api.OnRecordError
- store(String, String, long, String) - Method in interface com.streamsets.pipeline.api.BlobStore
-
Store a new object inside the blob store.
- store(List<String>, String, String) - Method in interface com.streamsets.pipeline.api.credential.ManagedCredentialStore
-
Returns a credential value associated to the given name.
- strategy() - Element in annotation interface com.streamsets.pipeline.api.ext.json.JsonRule
- STREAMING - Enum constant in enum class com.streamsets.pipeline.api.ExecutionMode
- STRING - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- STRING - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- submitJob(Properties) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Submits a pipeline job for execution to the cluster.
- suggestedWholeFileBufferSize() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Size of the buffer that the service suggest caller to use when transmitting whole files.
- supportedEngines() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
The possible execution engines that a Connection can support.
T
- TABLE - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
- tags() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Tags describing features of stage like object store, messaging queue.
- TAGS - Enum constant in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
- target - Variable in class com.streamsets.pipeline.api.base.configurablestage.DTargetOffsetCommitTrigger
- Target - Interface in com.streamsets.pipeline.api
-
A
Target
is a Data Collector destination stage. - TARGET - Enum constant in enum class com.streamsets.pipeline.api.StageType
- Target.Context - Interface in com.streamsets.pipeline.api
-
Target
stage context. - terminateCluster(String) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Destroys a cluster.
- terminateJob(Properties) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Terminates a pipeline job.
- text() - Element in annotation interface com.streamsets.pipeline.api.Placeholder
-
The text to display as a placeholder for this configuration field.
- text() - Method in class com.streamsets.pipeline.api.PlaceholderBean
- TEXT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Type
- TEXT - Enum constant in enum class com.streamsets.pipeline.api.ConfigDef.Upload
- TIME - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- TO_ERROR - Enum constant in enum class com.streamsets.pipeline.api.OnRecordError
- TO_ERROR - Enum constant in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileExistsAction
- toError(Record, ErrorCode, Object...) - Method in interface com.streamsets.pipeline.api.ToErrorContext
-
Sends a record to the pipeline error stream with an associated error code.
- toError(Record, Exception) - Method in interface com.streamsets.pipeline.api.ToErrorContext
-
Sends a record to the pipeline error stream with an associated
Exception
- toError(Record, String) - Method in interface com.streamsets.pipeline.api.ToErrorContext
-
Sends a record to the pipeline error stream with an associated non-localizable error message.
- ToErrorContext - Interface in com.streamsets.pipeline.api
-
Describes methods for various context classes that deals with error handling.
- toEvent(EventRecord) - Method in interface com.streamsets.pipeline.api.ToEventContext
-
Sends given event record to event lane.
- ToEventContext - Interface in com.streamsets.pipeline.api
-
Describes methods for various context classes that deals with error handling.
- toSourceResponse(Record) - Method in interface com.streamsets.pipeline.api.ToSourceResponseContext
-
Sends given record to source response list.
- ToSourceResponseContext - Interface in com.streamsets.pipeline.api
-
Describes methods for various context classes that deals with source response handling.
- toString() - Method in class com.streamsets.pipeline.api.Config
-
Returns the string representation of the configuration.
- toString() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Atom
- toString() - Method in class com.streamsets.pipeline.api.ExplorerSchema.Set
- toString() - Method in class com.streamsets.pipeline.api.ExplorerSchema
- toString() - Method in class com.streamsets.pipeline.api.ExplorerSearcher.Tree
- toString() - Method in class com.streamsets.pipeline.api.Field
-
Returns the string representation of the field.
- toString() - Method in interface com.streamsets.pipeline.api.lineage.LineageEvent
-
return formatted String containing LineageEvent data.
- toString() - Method in class com.streamsets.pipeline.api.service.sshtunnel.SshTunnelService.HostPort
- TRANSFORMER - Enum constant in enum class com.streamsets.pipeline.api.ConnectionEngine
- Tree(String, String) - Constructor for class com.streamsets.pipeline.api.ExplorerSearcher.Tree
-
Create a tree node.
- triggeredByValue() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The trigger values of the depends on configuration that activate this configuration.
- triggeredByValues() - Element in annotation interface com.streamsets.pipeline.api.Dependency
-
The trigger values of configName that activate this configuration.
- type() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The configuration type for the configuration variable.
- type() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
An internal, unique, and static name or ID for this Connection Definition.
- type() - Element in annotation interface com.streamsets.pipeline.api.EventDef
-
Type of the event, it's value is defined by generating stage.
- TYPE - Static variable in interface com.streamsets.pipeline.api.EventRecord
-
Type of the event, it's value is defined by generating stage.
U
- unregisterApiGateway(GatewayInfo) - Method in interface com.streamsets.pipeline.api.PushSource.Context
-
UnRegister API Gateway for given gateway info entity
- upgrade(String, String, String, int, int, List<Config>) - Method in interface com.streamsets.pipeline.api.StageUpgrader
-
Deprecated.use
StageUpgrader.upgrade(List, Context)
instead - upgrade(List<Config>, StageUpgrader.Context) - Method in class com.streamsets.pipeline.api.StageUpgrader.Default
-
This implementation always throws an exception.
- upgrade(List<Config>, StageUpgrader.Context) - Method in interface com.streamsets.pipeline.api.StageUpgrader
-
Upgrades the stage configuration from a previous version to current version.
- upgrade(List<Config>, StageUpgrader.ExtendedContext) - Method in interface com.streamsets.pipeline.api.StageUpgrader
-
Upgrades the stage configuration from a previous version to current version.
- upgrader() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Indicates the upgrader implementation class to use to upgrade stage configurations for older stage versions.
- upgrader() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the upgrader implementation class to use to upgrade stage configurations.
- UPGRADER_00 - Enum constant in enum class com.streamsets.pipeline.api.StageUpgrader.Error
- UPGRADER_01 - Enum constant in enum class com.streamsets.pipeline.api.StageUpgrader.Error
- upgraderDef() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
The YAML-based upgrader definition associated with this Connection Definition that knows how to upgrade a Connection configuration when the
ConnectionDef.version()
is incremented. - upgraderDef() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Defines the upgrader definition.
- upgraderDef() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Defines the upgrader definition.
- upload() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
The upload capability for the configuration.
- uploadJobFiles(Properties, List<File>) - Method in interface com.streamsets.pipeline.api.delegate.exported.ClusterJob.Client
-
Uploads pipeline job files to a filesystem accessible to the cluster.
- upTruncateResult() - Element in annotation interface com.streamsets.pipeline.api.ExplorerConfigDef
-
If Explorer UI should up truncate the results to start at the level of the searched schema element.
- useForExplorerLoad() - Element in annotation interface com.streamsets.pipeline.api.ConfigDef
-
If the stage uses explorer, set this property to TRUE to indicate the property should be used to create the explorer ExplorerData key, if this value changes the ExplorerData changes.
- USER_CODE_INJECTION - Enum constant in enum class com.streamsets.pipeline.api.StageBehaviorFlags
V
- VALID_ID_PATTERN - Static variable in interface com.streamsets.pipeline.api.BlobStore
-
Validation pattern for id.
- VALID_NAMESPACE_PATTERN - Static variable in interface com.streamsets.pipeline.api.BlobStore
-
Validation pattern for namespace.
- value() - Element in annotation interface com.streamsets.pipeline.api.ConfigGroups
-
Indicates the enum class implementing
Label
defining the groups of the stage configuration. - value() - Element in annotation interface com.streamsets.pipeline.api.delegate.StageLibraryDelegateDef
-
Interface that the delegate is exposing (exporting).
- value() - Element in annotation interface com.streamsets.pipeline.api.ElParam
-
UI name for the configName.
- value() - Element in annotation interface com.streamsets.pipeline.api.HideConfigs
-
Hides the specified user defined configurations from the UI.
- value() - Element in annotation interface com.streamsets.pipeline.api.HideStage
-
Type of the hidden stage, see for more details.
- value() - Element in annotation interface com.streamsets.pipeline.api.MultiValueChooserModel
-
Indicates the
ChooserValues
class providing the valid values. - value() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceConfiguration
-
Injected value.
- value() - Element in annotation interface com.streamsets.pipeline.api.ValueChooserModel
-
Indicates the
ChooserValues
class providing the valid values. - ValueChooserModel - Annotation Interface in com.streamsets.pipeline.api
-
Annotation for configuration variables that can hold a single value from a given list of values.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.base.Errors
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConfigDef.DisplayMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Evaluation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Upload
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ConnectionEngine
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.DeliveryGuarantee
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ExecutionMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Strategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.ext.json.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.Field.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.HideStage.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.interceptor.InterceptorCreator.InterceptorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.lineage.EndPointType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.OnRecordError
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.service.dataformats.Errors
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileExistsAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageBehaviorFlags
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageDef.DefaultInputStreams
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageDef.DefaultOutputStreams
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageDef.ExplorerSearchType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageDef.VariableOutputStreams
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageTags
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.streamsets.pipeline.api.StageUpgrader.Error
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.streamsets.pipeline.api.base.Errors
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConfigDef.DisplayMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Evaluation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConfigDef.Upload
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ConnectionEngine
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.DeliveryGuarantee
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ExecutionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Binding
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ExplorerConfigDef.Location
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Strategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.ext.json.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.Field.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.HideStage.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.interceptor.InterceptorCreator.InterceptorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.lineage.EndPointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.lineage.LineageEventType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.lineage.LineageLogicalEndPointTypes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.lineage.LineagePhysicalEndPointTypes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.lineage.LineageSpecificAttribute
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.OnRecordError
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.service.dataformats.Errors
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileChecksumAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.service.dataformats.WholeFileExistsAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageBehaviorFlags
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageDef.DefaultInputStreams
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageDef.DefaultOutputStreams
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageDef.ExplorerSearchType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageDef.VariableOutputStreams
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageTags
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.streamsets.pipeline.api.StageUpgrader.Error
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifierType() - Element in annotation interface com.streamsets.pipeline.api.ConnectionVerifierDef
-
The type of connection verified by this ConnectionVerifier object
- version() - Method in interface com.streamsets.pipeline.api.BlobStore.VersionedContent
-
Version of the content.
- version() - Element in annotation interface com.streamsets.pipeline.api.ConnectionDef
-
The current version of this Connection Definition.
- version() - Element in annotation interface com.streamsets.pipeline.api.EventDef
-
Indicates the version of the event.
- version() - Element in annotation interface com.streamsets.pipeline.api.interceptor.InterceptorDef
-
Indicated internal version of the interceptor.
- version() - Element in annotation interface com.streamsets.pipeline.api.service.ServiceDef
-
Indicates the version of the stage.
- version() - Element in annotation interface com.streamsets.pipeline.api.StageDef
-
Indicates the version of the stage.
- VERSION - Static variable in interface com.streamsets.pipeline.api.EventRecord
-
Each event type is versioned separately.
- visit(RecordField) - Method in interface com.streamsets.pipeline.api.FieldVisitor
-
Visit given field.
W
- wholeFileChecksumAlgorithm() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Return algorithm that should be used to calculate the checksum.
- WholeFileChecksumAlgorithm - Enum Class in com.streamsets.pipeline.api.service.dataformats
- wholeFileExistsAction() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
What should the stage return in case that destination file already exists.
- WholeFileExistsAction - Enum Class in com.streamsets.pipeline.api.service.dataformats
- wholeFileFilename(Record) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Return filename of given whole file format record.
- wholeFileIncludeChecksumInTheEvents() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatGeneratorService
-
Whether the generated event should contain checksum or not.
- wholeFileRateLimit() - Method in interface com.streamsets.pipeline.api.service.dataformats.DataFormatParserService
-
Rate limiting that the caller should apply when reading whole file format.
- write(Batch) - Method in class com.streamsets.pipeline.api.base.configurablestage.DExecutor
- write(Batch) - Method in class com.streamsets.pipeline.api.base.configurablestage.DTarget
- write(Batch) - Method in class com.streamsets.pipeline.api.base.RecordTarget
-
Writes the batch by calling the
RecordTarget.write(Record)
method for each record in the batch. - write(Batch) - Method in interface com.streamsets.pipeline.api.Target
-
When running a pipeline, the Data Collector calls this method from the
Target
stage to write a batch of records to an external system. - write(Record) - Method in class com.streamsets.pipeline.api.base.RecordTarget
-
Writes one record.
- write(Record) - Method in interface com.streamsets.pipeline.api.service.dataformats.DataGenerator
-
Write given record to the underlying stream.
- writeValueAsBytes(Object) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Serializes and array of bytes to a string.
- writeValueAsBytes(Object, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Serializes and array of bytes to a string, using optional runtime parameters.
- writeValueAsString(Object) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Serializes and object to a string.
- writeValueAsString(Object, Map<?, ?>) - Method in interface com.streamsets.pipeline.api.ext.json.JsonMapper
-
Serializes and object to a string, using optional runtime parameters.
Z
- ZONE_ID - Static variable in interface com.streamsets.pipeline.api.ext.json.delegate.LocalDateTimeDelegate.Parameters
- ZONED_DATE_TIME - Enum constant in enum class com.streamsets.pipeline.api.ext.json.JsonRule.Format
- ZONED_DATETIME - Enum constant in enum class com.streamsets.pipeline.api.Field.Type
- ZonedDateTimeDelegate - Class in com.streamsets.pipeline.api.ext.json.delegate
-
JSON Delegate used to produce Human-readable strings from ZonedDateTime objects.
- ZonedDateTimeDelegate(JsonRule) - Constructor for class com.streamsets.pipeline.api.ext.json.delegate.ZonedDateTimeDelegate
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form