Index (IoTDB: API: Pipe API 2.0.3 API)

A B C D E F G H I O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAttribute(String, String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
addOrReplaceEquivalentAttributes(PipeParameters) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters: This method adds (non-existed) or replaces (existed) equivalent attributes in this PipeParameters with those from another PipeParameters.
addOrReplaceEquivalentAttributesWithClone(PipeParameters) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters: This method clones a new PipeParameters with equivalent attributes in this PipeParameters added by (non-existed) or replaces with (existed) those from another PipeParameters.
attributes - Variable in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters

B

Binary - Class in org.apache.iotdb.pipe.api.type: Override compareTo() and equals() function to Binary class.
Binary(byte[]) - Constructor for class org.apache.iotdb.pipe.api.type.Binary: if the bytes v is modified, the modification is visible to this binary.
Binary(String) - Constructor for class org.apache.iotdb.pipe.api.type.Binary
BLOB - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
BOOLEAN - Enum constant in enum org.apache.iotdb.pipe.api.type.Type

C

collect(Event) - Method in interface org.apache.iotdb.pipe.api.collector.EventCollector: Collects a Event in pipe engine.
collectRow(Row) - Method in interface org.apache.iotdb.pipe.api.collector.RowCollector: Collects a row.
compareTo(Binary) - Method in class org.apache.iotdb.pipe.api.type.Binary
computeAttributeIfExists(BiFunction<String, String, String>, String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
CONNECTION_ERROR_FORMATTER - Static variable in exception org.apache.iotdb.pipe.api.exception.PipeConnectionException
customize(PipeParameters, PipeConnectorRuntimeConfiguration) - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is mainly used to customize PipeConnector.
customize(PipeParameters, PipeExtractorRuntimeConfiguration) - Method in interface org.apache.iotdb.pipe.api.PipeExtractor: Deprecated.

This method is mainly used to customize PipeExtractor.
customize(PipeParameters, PipeProcessorRuntimeConfiguration) - Method in interface org.apache.iotdb.pipe.api.PipeProcessor: This method is mainly used to customize PipeProcessor.
customize(PipeParameters, PipeSinkRuntimeConfiguration) - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is mainly used to customize PipeSink.
customize(PipeParameters, PipeSourceRuntimeConfiguration) - Method in interface org.apache.iotdb.pipe.api.PipeSource: This method is mainly used to customize PipeSource.

D

DATE - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
DOUBLE - Enum constant in enum org.apache.iotdb.pipe.api.type.Type

E

equals(Object) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
equals(Object) - Method in class org.apache.iotdb.pipe.api.type.Binary
Event - Interface in org.apache.iotdb.pipe.api.event: This interface is used to abstract events in collaboration tasks.
EventCollector - Interface in org.apache.iotdb.pipe.api.collector: Used to collect events in pipe engine.

F

FLOAT - Enum constant in enum org.apache.iotdb.pipe.api.type.Type

G

getAttribute() - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getBinary(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the Binary value at the specified column in this row.
getBoolean(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the boolean value at the specified column in this row.
getBoolean(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getBooleanByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getBooleanOrDefault(String, boolean) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getBooleanOrDefault(List<String>, boolean) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getColumnIndex(Path) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the actual column index of the given column (measurement) name.
getColumnName(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the actual column (measurement) name of the given column index.
getColumnTypes() - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the column data types in the Row.
getCreationTime() - Method in interface org.apache.iotdb.pipe.api.customizer.configuration.PipeRuntimeEnvironment
getDataType(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the actual data type of the value at the specified column in this row.
getDate(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the localDate value at the specified column in this row.
getDeviceId() - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the device id of the Row.
getDouble(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the double value at the specified column in this row.
getDouble(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getDoubleByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getDoubleOrDefault(String, double) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getDoubleOrDefault(List<String>, double) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getFloat(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the float value at the specified column in this row.
getFloat(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getFloatByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getFloatOrDefault(String, float) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getFloatOrDefault(List<String>, float) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getInt(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the int value at the specified column in this row.
getInt(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getIntByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getIntOrDefault(String, int) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getIntOrDefault(List<String>, int) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getLength() - Method in class org.apache.iotdb.pipe.api.type.Binary: Get length of values.
getLong(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the long value at the specified column in this row.
getLong(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getLongByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getLongOrDefault(String, long) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getLongOrDefault(List<String>, long) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getObject(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the raw Object stored at the specified column in this row.
getParameters() - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator
getPipeName() - Method in interface org.apache.iotdb.pipe.api.customizer.configuration.PipeRuntimeEnvironment
getRegionId() - Method in interface org.apache.iotdb.pipe.api.customizer.configuration.PipeRuntimeEnvironment
getRuntimeEnvironment() - Method in interface org.apache.iotdb.pipe.api.customizer.configuration.PipeRuntimeConfiguration
getSourceEvent() - Method in class org.apache.iotdb.pipe.api.event.UserDefinedEvent
getString(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the String value at the specified column in this row.
getString(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getStringByKeys(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getStringOrDefault(String, String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getStringOrDefault(List<String>, String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
getStringValue() - Method in class org.apache.iotdb.pipe.api.type.Binary
getTextEncodingType() - Method in class org.apache.iotdb.pipe.api.type.Binary
getTime() - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the timestamp of this row.
getTimeStamp() - Method in exception org.apache.iotdb.pipe.api.exception.PipeException
getType() - Method in enum org.apache.iotdb.pipe.api.type.Type
getValues() - Method in class org.apache.iotdb.pipe.api.type.Binary

H

handshake() - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is used to create a connection with sink.
handshake() - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is used to create a connection with sink.
hasAnyAttributes(String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
hasAttribute(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
hashCode() - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
hashCode() - Method in class org.apache.iotdb.pipe.api.type.Binary
heartbeat() - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method will be called periodically to check whether the connection with sink is still alive.
heartbeat() - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method will be called periodically to check whether the connection with sink is still alive.

I

INT32 - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
INT64 - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
isNull() - Method in class org.apache.iotdb.pipe.api.type.Binary
isNull(int) - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns true if the value of the specified column is null.

O

org.apache.iotdb.pipe.api - package org.apache.iotdb.pipe.api
org.apache.iotdb.pipe.api.access - package org.apache.iotdb.pipe.api.access
org.apache.iotdb.pipe.api.annotation - package org.apache.iotdb.pipe.api.annotation
org.apache.iotdb.pipe.api.collector - package org.apache.iotdb.pipe.api.collector
org.apache.iotdb.pipe.api.customizer.configuration - package org.apache.iotdb.pipe.api.customizer.configuration
org.apache.iotdb.pipe.api.customizer.parameter - package org.apache.iotdb.pipe.api.customizer.parameter
org.apache.iotdb.pipe.api.event - package org.apache.iotdb.pipe.api.event
org.apache.iotdb.pipe.api.event.dml.insertion - package org.apache.iotdb.pipe.api.event.dml.insertion
org.apache.iotdb.pipe.api.exception - package org.apache.iotdb.pipe.api.exception
org.apache.iotdb.pipe.api.type - package org.apache.iotdb.pipe.api.type

P

PipeAttributeNotProvidedException - Exception in org.apache.iotdb.pipe.api.exception
PipeAttributeNotProvidedException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeAttributeNotProvidedException
PipeConnectionException - Exception in org.apache.iotdb.pipe.api.exception
PipeConnectionException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeConnectionException
PipeConnectionException(String, Throwable) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeConnectionException
PipeConnector - Interface in org.apache.iotdb.pipe.api: Deprecated.
PipeConnectorRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeConsensusRetryWithIncreasingIntervalException - Exception in org.apache.iotdb.pipe.api.exception
PipeConsensusRetryWithIncreasingIntervalException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeConsensusRetryWithIncreasingIntervalException
PipeException - Exception in org.apache.iotdb.pipe.api.exception
PipeException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeException
PipeException(String, long) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeException
PipeException(String, Throwable) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeException
PipeExtractor - Interface in org.apache.iotdb.pipe.api: Deprecated.
PipeExtractorRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeParameterNotValidException - Exception in org.apache.iotdb.pipe.api.exception
PipeParameterNotValidException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeParameterNotValidException
PipeParameters - Class in org.apache.iotdb.pipe.api.customizer.parameter: Used in PipeExtractor.customize(PipeParameters, PipeExtractorRuntimeConfiguration) , PipeProcessor.customize(PipeParameters, PipeProcessorRuntimeConfiguration) and PipeConnector.customize(PipeParameters, PipeConnectorRuntimeConfiguration).
PipeParameters(Map<String, String>) - Constructor for class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
PipeParameters.ValueHider - Class in org.apache.iotdb.pipe.api.customizer.parameter
PipeParameterValidator - Class in org.apache.iotdb.pipe.api.customizer.parameter
PipeParameterValidator(PipeParameters) - Constructor for class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator
PipeParameterValidator.MultipleObjectsValidationRule - Interface in org.apache.iotdb.pipe.api.customizer.parameter
PipeParameterValidator.SingleObjectValidationRule - Interface in org.apache.iotdb.pipe.api.customizer.parameter
PipePlugin - Interface in org.apache.iotdb.pipe.api: PipePlugin
PipeProcessor - Interface in org.apache.iotdb.pipe.api: PipeProcessor
PipeProcessorRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeRuntimeEnvironment - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeSink - Interface in org.apache.iotdb.pipe.api: PipeSink
PipeSinkException - Exception in org.apache.iotdb.pipe.api.exception
PipeSinkException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeSinkException
PipeSinkException(String, Throwable) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeSinkException
PipeSinkRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeSource - Interface in org.apache.iotdb.pipe.api: PipeSource
PipeSourceRuntimeConfiguration - Interface in org.apache.iotdb.pipe.api.customizer.configuration
PipeStrategyNotValidException - Exception in org.apache.iotdb.pipe.api.exception
PipeStrategyNotValidException(String) - Constructor for exception org.apache.iotdb.pipe.api.exception.PipeStrategyNotValidException
process(TabletInsertionEvent, EventCollector) - Method in interface org.apache.iotdb.pipe.api.PipeProcessor: This method is called to process the TabletInsertionEvent.
process(TsFileInsertionEvent, EventCollector) - Method in interface org.apache.iotdb.pipe.api.PipeProcessor: This method is called to process the TsFileInsertionEvent.
process(Event, EventCollector) - Method in interface org.apache.iotdb.pipe.api.PipeProcessor: This method is called to process the generic Event.
processRowByRow(BiConsumer<Row, RowCollector>) - Method in interface org.apache.iotdb.pipe.api.event.dml.insertion.TabletInsertionEvent: The consumer processes the data row by row and collects the results by RowCollector.
processTablet(BiConsumer<Tablet, RowCollector>) - Method in interface org.apache.iotdb.pipe.api.event.dml.insertion.TabletInsertionEvent: The consumer processes the Tablet directly and collects the results by RowCollector.

R

Row - Interface in org.apache.iotdb.pipe.api.access
RowCollector - Interface in org.apache.iotdb.pipe.api.collector: Used to collect rows generated by TabletInsertionEvent.processRowByRow(BiConsumer), TabletInsertionEvent.processTablet(BiConsumer).

S

size() - Method in interface org.apache.iotdb.pipe.api.access.Row: Returns the number of columns (excluding the timestamp column).
sourceEvent - Variable in class org.apache.iotdb.pipe.api.event.UserDefinedEvent: The user defined event is generated from this source event.
start() - Method in interface org.apache.iotdb.pipe.api.PipeExtractor: Deprecated.

Start the PipeExtractor.
start() - Method in interface org.apache.iotdb.pipe.api.PipeSource: Start the PipeSource.
STRING - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
STRING_CHARSET - Static variable in class org.apache.iotdb.pipe.api.type.Binary
STRING_ENCODING - Static variable in class org.apache.iotdb.pipe.api.type.Binary
stringToBytes(String) - Static method in class org.apache.iotdb.pipe.api.type.Binary: convert string to byte array using UTF-8 encoding.
supply() - Method in interface org.apache.iotdb.pipe.api.PipeExtractor: Deprecated.

Supply single Event from the PipeExtractor and the caller will send the Event to the PipeProcessor.
supply() - Method in interface org.apache.iotdb.pipe.api.PipeSource: Supply single Event from the PipeSource and the caller will send the Event to the PipeProcessor.

T

TableModel - Annotation Type in org.apache.iotdb.pipe.api.annotation: Indicates that a plugin can be used in table model environments.
TabletInsertionEvent - Interface in org.apache.iotdb.pipe.api.event.dml.insertion: TabletInsertionEvent is used to define the event of data insertion.
TEXT - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
TIMESTAMP - Enum constant in enum org.apache.iotdb.pipe.api.type.Type
toString() - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters: When exposing the content of this `PipeParameters` to external sources (such as `show pipes` or logging), please use this `toString` method to prevent the leakage of private information.
toString() - Method in class org.apache.iotdb.pipe.api.type.Binary
toTabletInsertionEvents() - Method in interface org.apache.iotdb.pipe.api.event.dml.insertion.TsFileInsertionEvent: The method is used to convert the TsFileInsertionEvent into several TabletInsertionEvents.
transfer(TabletInsertionEvent) - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is used to transfer the TabletInsertionEvent.
transfer(TabletInsertionEvent) - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is used to transfer the TabletInsertionEvent.
transfer(TsFileInsertionEvent) - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is used to transfer the TsFileInsertionEvent.
transfer(TsFileInsertionEvent) - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is used to transfer the TsFileInsertionEvent.
transfer(Event) - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is used to transfer generic Events.
transfer(Event) - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is used to transfer the generic Events, including HeartbeatEvent.
TreeModel - Annotation Type in org.apache.iotdb.pipe.api.annotation: Indicates that a plugin can be used in tree model environments.
TsFileInsertionEvent - Interface in org.apache.iotdb.pipe.api.event.dml.insertion: TsFileInsertionEvent is used to define the event of writing TsFile.
Type - Enum in org.apache.iotdb.pipe.api.type

U

UserDefinedEvent - Class in org.apache.iotdb.pipe.api.event: User defined event is used to wrap data generated by users, keeping a source event to automatically report the processing progress to pipe engine.
UserDefinedEvent() - Constructor for class org.apache.iotdb.pipe.api.event.UserDefinedEvent: Generate a user defined event without source event.
UserDefinedEvent(Event) - Constructor for class org.apache.iotdb.pipe.api.event.UserDefinedEvent

V

validate(Object) - Method in interface org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator.SingleObjectValidationRule
validate(Object...) - Method in interface org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator.MultipleObjectsValidationRule
validate(PipeParameterValidator) - Method in interface org.apache.iotdb.pipe.api.PipeConnector: Deprecated.

This method is mainly used to validate PipeParameters and it is executed before PipeConnector.customize(PipeParameters, PipeConnectorRuntimeConfiguration) is called.
validate(PipeParameterValidator) - Method in interface org.apache.iotdb.pipe.api.PipeExtractor: Deprecated.

This method is mainly used to validate PipeParameters and it is executed before PipeExtractor.customize(PipeParameters, PipeExtractorRuntimeConfiguration) is called.
validate(PipeParameterValidator) - Method in interface org.apache.iotdb.pipe.api.PipeProcessor: This method is mainly used to validate PipeParameters and it is executed before PipeProcessor.customize(PipeParameters, PipeProcessorRuntimeConfiguration) is called.
validate(PipeParameterValidator) - Method in interface org.apache.iotdb.pipe.api.PipeSink: This method is mainly used to validate PipeParameters and it is executed before PipeSink.customize(PipeParameters, PipeSinkRuntimeConfiguration) is called.
validate(PipeParameterValidator) - Method in interface org.apache.iotdb.pipe.api.PipeSource: This method is mainly used to validate PipeParameters and it is executed before PipeSource.customize(PipeParameters, PipeSourceRuntimeConfiguration) is called.
validate(PipeParameterValidator.MultipleObjectsValidationRule, String, Object...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator: Validates the input parameters according to the validation rule given by the user.
validate(PipeParameterValidator.SingleObjectValidationRule, String, Object) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator: Validates the input parameters according to the validation rule given by the user.
validateAttributeValueRange(String, boolean, String...) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator
validateRequiredAttribute(String) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator: Validates whether the attributes entered by the user contain an attribute whose key is attributeKey.
validateSynonymAttributes(List<String>, List<String>, boolean) - Method in class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameterValidator: Validates whether the attributes entered by the user contain at least one attribute from lhsAttributes or rhsAttributes (if required), but not both.
ValueHider() - Constructor for class org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters.ValueHider
valueOf(String) - Static method in class org.apache.iotdb.pipe.api.type.Binary
valueOf(String) - Static method in enum org.apache.iotdb.pipe.api.type.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.iotdb.pipe.api.type.Type: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form