A B C D E F G H I J L M N O P R S T U V W Y

A

adjustMaxCloneLimit(int) - Method in class com.aliyun.odps.io.SourceInputStream

Allow adjustment on the upper limit for number of maximum cloned streams allowed.

Aggregator - Class in com.aliyun.odps.udf

继承 Aggregator 实现 UDAF。
UDAF (User Defined Aggregation Function) ：用户自定义聚合函数，其输入输出是多对一的关系，即将多条输入记录聚合成一条输出值。 可以与 SQL 中的 Group By 语句联用。

实现 Java UDAF 类需要继承 Aggregator 类。
Aggregator 流程主要分为四部分，分别对应四个主要接口： Aggregator.newBuffer() 聚合中间值 buffer 的创建和初始化。 Aggregator.iterate(Writable, Writable[]) 实现此方法对输入数据进行计算，聚合到中间值 buffer。其中第一个参数是 newBuffer() 产生的结果，第二个参数是数据源。 Aggregator.merge(Writable, Writable) 实现此方法将两个中间值 merge 聚合到一起。其中第一个参数是 newBuffer() 产生的结果，第二个参数是 iterate 操作完成后产生的中间结果。 Aggregator.terminate(Writable) 实现此方法将 merge 操作完成后产生的中间结果转换为 ODPS SQL 基本类型。
初始化流程在Aggregator.setup(ExecutionContext)调用中完成，用户可重写此方法来实现一次性初始操作，例如共享资源的读取等。
聚合过程的中间数据 buffer 类继承于 Writable, 除内建类型外，用户可继承 Writable 类实现自定义类。
buffer 大小不应该随数据量递增，最好不要超过 2MB，否则会造成内存占用过大。

Aggregator() - Constructor for class com.aliyun.odps.udf.Aggregator

AnnotationParser - Class in com.aliyun.odps.udf.impl

UDF SDK中用于内部实现的功能，这部分不属于API，接口随时可能改变，不推荐使用。

AnnotationParser() - Constructor for class com.aliyun.odps.udf.impl.AnnotationParser

AnnotationParser.ParseError - Exception in com.aliyun.odps.udf.impl

AnnotationParser.ParseResult - Class in com.aliyun.odps.udf.impl

AnnotationParser.Prototype - Class in com.aliyun.odps.udf.impl

available() - Method in class com.aliyun.odps.io.SourceInputStream

B

BaseStorageHandler - Interface in com.aliyun.odps.udf

This is the interface on top of which both Hive-compatible and ODPS storage handlers are built Internal usage *ONLY* within ODPS framework.

BridgeStorageHandler - Interface in com.aliyun.odps.udf

Hive-compatible APIs for building storage handler TODO: see if we can remove bridged version of inputformat and outputformat, then we can have BridgeHiveStorageHandler implements *both* BaseStorageHandler and Hive's HiveStorageHandler interfaces

C

claimAlive() - Method in class com.aliyun.odps.udf.ExecutionContext

在UDF运行期调用此方法防止worker因超时被强制终止。

cloneStream() - Method in class com.aliyun.odps.io.SourceInputStream

Clone a stream, the clone is a separate handle to the source data.

close() - Method in class com.aliyun.odps.io.SinkOutputStream

output stream shall be closed by the system AFTER Outputer::close() calling close() on SinkOutputStream is a no-op

close() - Method in class com.aliyun.odps.io.SourceInputStream

close() - Method in class com.aliyun.odps.udf.Aggregator

扫尾工作

close() - Method in interface com.aliyun.odps.udf.ContextFunction

close() - Method in class com.aliyun.odps.udf.Extractor

Interface for operations upon extractor exit, implementation can be no-op

close() - Method in class com.aliyun.odps.udf.Outputer

Interface for cleaning up outputer before exit.

close() - Method in interface com.aliyun.odps.udf.RecordReader

close() - Method in interface com.aliyun.odps.udf.RecordWriter

close() - Method in interface com.aliyun.odps.udf.TableRecordReader

close() - Method in class com.aliyun.odps.udf.UDF

close() - Method in class com.aliyun.odps.udf.UDJ

Interface for operations upon udj exit, implementation can be no-op

close() - Method in class com.aliyun.odps.udf.UDTF

在UDTF运行期，UDTF.process(Object[])把全部记录处理完以之后， 即当前实例没有其它需要处理的记录了，UDTF.close()}此时会被调用一次。

close() - Method in class com.aliyun.odps.udf.VectorizedExtractor

Interface for operations upon extractor exit, implementation can be no-op

close() - Method in class com.aliyun.odps.udf.VectorizedOutputer

Interface for operations upon outputer exit, implementation can be no-op

collect(Object[]) - Method in interface com.aliyun.odps.udf.DataCollector

collect(Object[]) - Method in interface com.aliyun.odps.udf.UDTFCollector

其它类（UDTF）会调用此方法，以收集每一行数据

com.aliyun.odps - package com.aliyun.odps

com.aliyun.odps.exec - package com.aliyun.odps.exec

com.aliyun.odps.io - package com.aliyun.odps.io

com.aliyun.odps.serde - package com.aliyun.odps.serde

com.aliyun.odps.udf - package com.aliyun.odps.udf

UDF API 主要包括 UDF（User Defined Function，用户自定义函数） 和 UDTF （User Defined Table-generating Function，用户自定义生成表函数）

com.aliyun.odps.udf.annotation - package com.aliyun.odps.udf.annotation

UDF annotation，用于在Java代码中静态标记UDF的输入、输出类型。

com.aliyun.odps.udf.impl - package com.aliyun.odps.udf.impl

UDF SDK中用于内部实现的功能，这部分不属于API，接口随时可能改变，不推荐使用。

com.aliyun.odps.udf.utils - package com.aliyun.odps.udf.utils

commit() - Method in class com.aliyun.odps.udf.VectorizedOutputer

CommitMessage - Interface in com.aliyun.odps.udf

commitTableWrite(Collection<CommitMessage>) - Method in interface com.aliyun.odps.udf.Committer

Committer - Interface in com.aliyun.odps.udf

Constants - Class in com.aliyun.odps.udf.impl

Constants() - Constructor for class com.aliyun.odps.udf.impl.Constants

ContextFunction - Interface in com.aliyun.odps.udf

拥有 ExecutionContext的一类自定义函数。

CounterUtils - Class in com.aliyun.odps.udf.utils

与 Counter 相关的静态工具类，包含一些工具方法

CounterUtils() - Constructor for class com.aliyun.odps.udf.utils.CounterUtils

createFromJsonString(String) - Static method in class com.aliyun.odps.udf.utils.CounterUtils

通过JSON字符串创建Counters对象 字符串异常时会抛出 RuntimeException

createRecord() - Method in interface com.aliyun.odps.udf.RecordReader

Create an Writable of the appropriate type to be used as a record.

D

DataAttributes - Class in com.aliyun.odps.udf

Provides interfaces to access different attributes of the underlying data, including the attributes provided by the user, as well as different (system) properties that govern the underlying data, such as the record columns, resources used, etc.

DataAttributes() - Constructor for class com.aliyun.odps.udf.DataAttributes

DataCollector - Interface in com.aliyun.odps.udf

deserialize(byte[]) - Method in interface com.aliyun.odps.udf.CommitMessage

deserialize(byte[]) - Method in interface com.aliyun.odps.udf.InputSplit

deserialize(Writable) - Method in class com.aliyun.odps.udf.RecordSerDe

Deserialize an Record out of a Writable blob.

DynamicPtWriteCommitMessage - Interface in com.aliyun.odps.udf

E

ExecutionContext - Class in com.aliyun.odps.udf

运行时的执行上下文信息。

ExecutionContext() - Constructor for class com.aliyun.odps.udf.ExecutionContext

ExecutionContextReporter - Class in com.aliyun.odps.exec

Reporter implemented by ExecutionContext

ExecutionContextReporter(ExecutionContext) - Constructor for class com.aliyun.odps.exec.ExecutionContextReporter

extract() - Method in class com.aliyun.odps.udf.Extractor

Interface for extracting a schematized record from an input stream

extract(int) - Method in class com.aliyun.odps.udf.VectorizedExtractor

Interface for read.

Extractor - Class in com.aliyun.odps.udf

Base extractor class, user-defined extractors shall extend from this class

Extractor() - Constructor for class com.aliyun.odps.udf.Extractor

F

flush() - Method in class com.aliyun.odps.io.SinkOutputStream

Note that system will be performing memory control in the background, and will flush data only when it is deemed necessary, therefore the flush here would be no-op.

G

getArguments() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

getArgumentsString() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

getAttributes() - Method in class com.aliyun.odps.udf.DataAttributes

Get a copy of all user-specified attributes.

getBackupWorkerID() - Method in class com.aliyun.odps.udf.ExecutionContext

获取当前的backupWorkerID

getBytesRead() - Method in class com.aliyun.odps.io.SourceInputStream

Get total number of bytes read by current inputstream so far Note1: this can be less than (e.g., not all bytes read) or larger than (e.g., repeated reads from part of the input via seek operation) the physical size of the file underlying the input stream Note2: this denotes the "meaningful" size of read, bytes read into buffer but discarded (e.g., due to seek operation) are not accounted for.

getBytesRead() - Method in interface com.aliyun.odps.udf.Statistics

getBytesWritten() - Method in class com.aliyun.odps.io.SinkOutputStream

Get total number of bytes written by current output stream so far

getBytesWritten() - Method in interface com.aliyun.odps.udf.Statistics

getCollector() - Method in class com.aliyun.odps.udf.UDTF

获取UDTF的默认UDTFCollector对象。

getCommitterClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

getConfigurations() - Method in class com.aliyun.odps.udf.ExecutionContext

getCounter(Enum<?>) - Method in class com.aliyun.odps.exec.ExecutionContextReporter

getCounter(String, String) - Method in class com.aliyun.odps.exec.ExecutionContextReporter

getCounter(Enum<?>) - Method in interface com.aliyun.odps.exec.Reporter

Get the Counter of the given group with the given name.

getCounter(String, String) - Method in interface com.aliyun.odps.exec.Reporter

Get the Counter of the given group with the given name.

getCounter(Enum<?>) - Method in class com.aliyun.odps.udf.ExecutionContext

通过Enum获取Counter

getCounter(String, String) - Method in class com.aliyun.odps.udf.ExecutionContext

通过Group名和Counter名获取Counter

getCurrentPos() - Method in class com.aliyun.odps.io.SourceInputStream

Getter for current position of the cursor, within the physical file

getCustomizedDataLocation() - Method in class com.aliyun.odps.udf.DataAttributes

Get the customized external data location that describes external data storage location other than storage types with built-in support (such as Aliyun OSS/TableStore), user is responsible for parsing and connecting to customized data location in self-defined Extractor and/or Outputer

getDynamicPartitionColumnIndices() - Method in class com.aliyun.odps.udf.TableOutputerAttributes

getDynamicPtWriteInfo() - Method in interface com.aliyun.odps.udf.DynamicPtWriteCommitMessage

getEstimateBytes() - Method in interface com.aliyun.odps.udf.InputSplit

getEstimateRows() - Method in interface com.aliyun.odps.udf.InputSplit

getExtractorClass() - Method in interface com.aliyun.odps.udf.BaseStorageHandler

Getter for the underlying Extractor in OdpsStorageHandler

getExtractorClass() - Method in class com.aliyun.odps.udf.OdpsStorageHandler

Getter for underlying extractor class

getExtractorClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

getFileName() - Method in class com.aliyun.odps.io.SourceInputStream

Getter for the file name associated with the file being streamed in.

getFileSize() - Method in class com.aliyun.odps.io.SourceInputStream

Getter for the size in [bytes] of the physical file currently being processed.

getFullTableColumns() - Method in class com.aliyun.odps.udf.DataAttributes

Getter for record columns describing the FULL schema of underlying physical data, represented by the (external) table

getHiveTableProperties(boolean) - Method in class com.aliyun.odps.udf.DataAttributes

Deprecated.

getHiveTableProperties() - Method in class com.aliyun.odps.udf.DataAttributes

getInputFormatClass() - Method in interface com.aliyun.odps.udf.BridgeStorageHandler

Hive compatibility API

getInputSplit() - Method in class com.aliyun.odps.exec.ExecutionContextReporter

getInputSplit() - Method in interface com.aliyun.odps.exec.Reporter

Get the InputSplit object for a map.

getInputSplitClass() - Method in interface com.aliyun.odps.udf.InputSplitter

getInputSplitterClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

getInputVolumeFileSystem() - Method in class com.aliyun.odps.udf.ExecutionContext

getInputVolumeFileSystem(String) - Method in class com.aliyun.odps.udf.ExecutionContext

getInputVolumeInfo() - Method in class com.aliyun.odps.udf.ExecutionContext

getInputVolumeInfo(String) - Method in class com.aliyun.odps.udf.ExecutionContext

getInstanceID() - Method in class com.aliyun.odps.udf.ExecutionContext

获取ODPS Instance ID

getIsOverwrite() - Method in class com.aliyun.odps.udf.TableOutputerAttributes

Whether the underlying output operation is insert overwrite.

getLength() - Method in class com.aliyun.odps.exec.InputSplit

Get the total number of bytes in the data of the InputSplit.

getLocations() - Method in class com.aliyun.odps.exec.InputSplit

Get the list of hostnames where the input split is located.

getMetaFileLocation(String) - Static method in class com.aliyun.odps.io.IoUtils

If data has been output by ODPS through external table, this returns the expected location of the meta file generated by ODPS, see IoUtils.parseOutputSubDirectoriesFromMeta(String) for getting the list of valid subdirectories output from meta file.

getNeededIndexes() - Method in class com.aliyun.odps.udf.DataAttributes

Getter for needed indexes, this can be used to skip deserialization of non-needed column(s).

getNextRow() - Method in class com.aliyun.odps.udf.StandaloneUDTF

获取下一条记录

getNextRow() - Method in interface com.aliyun.odps.udf.UDTFPuller

从数据源中获取一条记录。

getOdpsType(String) - Static method in class com.aliyun.odps.udf.utils.TypeUtils

getOutputerClass() - Method in interface com.aliyun.odps.udf.BaseStorageHandler

Getter for the underlying Outputer in OdpsStorageHandler

getOutputerClass() - Method in class com.aliyun.odps.udf.OdpsStorageHandler

Getter for underlying outputer class

getOutputerClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

getOutputFormatClass() - Method in interface com.aliyun.odps.udf.BridgeStorageHandler

Hive compatibility API

getOutputVolumeFileSystem() - Method in class com.aliyun.odps.udf.ExecutionContext

getOutputVolumeFileSystem(String) - Method in class com.aliyun.odps.udf.ExecutionContext

getOutputVolumeInfo() - Method in class com.aliyun.odps.udf.ExecutionContext

getOutputVolumeInfo(String) - Method in class com.aliyun.odps.udf.ExecutionContext

getProgress() - Method in class com.aliyun.odps.exec.ExecutionContextReporter

getProgress() - Method in interface com.aliyun.odps.exec.Reporter

Get the progress of the task.

getProtoTypes() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

getPuller() - Method in class com.aliyun.odps.udf.StandaloneUDTF

getReadBytes() - Method in class com.aliyun.odps.udf.VectorizedExtractor

getRecordColumns() - Method in class com.aliyun.odps.udf.DataAttributes

Getter for columns describing expected Record schema: un-used columns may have been pruned and this schema therefore can be either 1.

getRecordReader(InputSplit, Configuration, Reporter) - Method in interface com.aliyun.odps.udf.InputFormat

Get the RecordReader for the given InputSplit.

getRecordWriter(Configuration, String, Class, boolean, Properties, Reporter) - Method in interface com.aliyun.odps.udf.OutputFormat

getRemainingExpr() - Method in class com.aliyun.odps.udf.RowExpression

getResources() - Method in class com.aliyun.odps.udf.DataAttributes

Getter for set of resources.

getResourceTableReader(String) - Method in class com.aliyun.odps.udf.ExecutionContext

getRetryCount() - Method in class com.aliyun.odps.udf.ExecutionContext

获取运行时当前Worker的重试次数

getReturns() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

getReturnsString() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

getRunningProject() - Method in class com.aliyun.odps.udf.ExecutionContext

获取运行时的Project名

getSerDeClass() - Method in interface com.aliyun.odps.udf.BridgeStorageHandler

Hive compatibility API

getSerializedClass() - Method in class com.aliyun.odps.udf.RecordSerDe

getSplitInBytes() - Method in class com.aliyun.odps.udf.InputSplitter.SplitStrategy

getSplits(Configuration, int) - Method in interface com.aliyun.odps.udf.InputFormat

Logically split the set of input files for the job.

getSplitSize() - Method in class com.aliyun.odps.io.SourceInputStream

Getter for the split size supposedly assigned to the input stream.

getSplitStart() - Method in class com.aliyun.odps.io.SourceInputStream

Getter for the start position (within the physical stream) that is assigned to the input stream to process.

getStageID() - Method in class com.aliyun.odps.udf.ExecutionContext

获取运行时StageID

getStaticPartitionName() - Method in class com.aliyun.odps.udf.TableOutputerAttributes

getStaticPartitionVals() - Method in class com.aliyun.odps.udf.DataAttributes

getSystemOutputDirectory(String) - Static method in class com.aliyun.odps.io.IoUtils

Get the system directory ODPS used when outputting unstructured data

getTableInfo() - Method in class com.aliyun.odps.udf.ExecutionContext

获取运行时处理的数据块所属的表或分区信息。

getTempFileSystem() - Method in class com.aliyun.odps.udf.ExecutionContext

getTotalYieldCount() - Method in interface com.aliyun.odps.Yieldable

getValueByKey(String) - Method in class com.aliyun.odps.udf.DataAttributes

Get the attribute value associated with the given key, return null if key not found

getVectorizedExtractorClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

Getter for underlying VectorizedExtractor class

getVectorizedOutputerClass() - Method in class com.aliyun.odps.udf.VectorizedStorageHandler

Getter for underlying VectorizedOutputer class

getWorkerID() - Method in class com.aliyun.odps.udf.ExecutionContext

获取运行时WorkerID

H

hasNext() - Method in interface com.aliyun.odps.udf.TableRecordReader

I

incrCounter(Enum<?>, long) - Method in class com.aliyun.odps.exec.ExecutionContextReporter

incrCounter(String, String, long) - Method in class com.aliyun.odps.exec.ExecutionContextReporter

incrCounter(Enum<?>, long) - Method in interface com.aliyun.odps.exec.Reporter

Increments the counter identified by the key, which can be of any Enum type, by the specified amount.

incrCounter(String, String, long) - Method in interface com.aliyun.odps.exec.Reporter

Increments the counter identified by the group and counter name by the specified amount.

init(UDTFPuller) - Method in class com.aliyun.odps.udf.StandaloneUDTF

该方法由框架调用来初始化 StandaloneUDTF

initialize(Configuration, Properties) - Method in class com.aliyun.odps.udf.RecordSerDe

Initialize the SerDe.

initialize(OdpsType[]) - Method in class com.aliyun.odps.udf.UDTF

Deprecated.

InputFormat - Interface in com.aliyun.odps.udf

TODO: see if we can remove this

InputSplit - Class in com.aliyun.odps.exec

InputSplit represents the data to be processed by an individual mapper.

InputSplit() - Constructor for class com.aliyun.odps.exec.InputSplit

InputSplit - Interface in com.aliyun.odps.udf

InputSplitter - Interface in com.aliyun.odps.udf

InputSplitter.SplitStrategy - Class in com.aliyun.odps.udf

InputStreamSet - Interface in com.aliyun.odps.io

Encapsulation class that hosts a collection of input streams, each corresponding to a file.

InvalidInvocationException - Exception in com.aliyun.odps.udf

InvalidInvocationException(Throwable) - Constructor for exception com.aliyun.odps.udf.InvalidInvocationException

InvalidInvocationException(String) - Constructor for exception com.aliyun.odps.udf.InvalidInvocationException

IoUtils - Class in com.aliyun.odps.io

IoUtils() - Constructor for class com.aliyun.odps.io.IoUtils

isDynamicPartition() - Method in class com.aliyun.odps.udf.TableOutputerAttributes

isVariadic() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

isWriable() - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

iterate(Writable, Writable[]) - Method in class com.aliyun.odps.udf.Aggregator

对输入进行计算，生成中间结果

J

join(Record, Iterator<Record>, Iterator<Record>, Yieldable<Record>) - Method in class com.aliyun.odps.udf.UDJ

Interface for setting up the udj, implementation can be a no-op

L

LIST_COLUMN_TYPES - Static variable in class com.aliyun.odps.serde.SerdeConstants

LIST_COLUMNS - Static variable in class com.aliyun.odps.serde.SerdeConstants

LIST_READ_COLUMN_IDS - Static variable in class com.aliyun.odps.serde.SerdeConstants

LIST_READ_COLUMN_NAMES - Static variable in class com.aliyun.odps.serde.SerdeConstants

M

mark(int) - Method in class com.aliyun.odps.io.SourceInputStream

markSupported() - Method in class com.aliyun.odps.io.SourceInputStream

merge(Writable, Writable) - Method in class com.aliyun.odps.udf.Aggregator

聚合中间结果，将 partial merge 到 buffer

N

newBuffer() - Method in class com.aliyun.odps.udf.Aggregator

创建聚合Buffer

next() - Method in interface com.aliyun.odps.io.InputStreamSet

Access method for getting next available stream

next() - Method in interface com.aliyun.odps.io.OutputStreamSet

Access method for getting next output stream.

next(String) - Method in interface com.aliyun.odps.io.OutputStreamSet

Get next output stream with specified postfix name.

next(Writable) - Method in interface com.aliyun.odps.udf.RecordReader

Reads the next record as Writable from the input for processing.

next() - Method in interface com.aliyun.odps.udf.TableRecordReader

NotImplementedException - Exception in com.aliyun.odps

NotImplementedException() - Constructor for exception com.aliyun.odps.NotImplementedException

NotImplementedException(String) - Constructor for exception com.aliyun.odps.NotImplementedException

NotImplementedException(Throwable) - Constructor for exception com.aliyun.odps.NotImplementedException

NotReuseArgumentObject - Annotation Type in com.aliyun.odps.udf.annotation

在默认情况下，UDTF的参数对象是复用的，如果加上该annotation， 则对参数对象不进行复用，每次调用都会创建新的对象。

O

OdpsStorageHandler - Class in com.aliyun.odps.udf

Recommended class (over HiveStorageHandler) to extend from for custom storage handler This provides interfaces to reason about the Extractor/Outputer implemented by the user, for converting raw byte stream into records and vice versa.

OdpsStorageHandler() - Constructor for class com.aliyun.odps.udf.OdpsStorageHandler

OdpsType - Enum in com.aliyun.odps.udf

映射到ODPS数据类型，包括 STRING：字符串 BIGINT：长整数型 DOUBLE：双精度符点数类型 BOOLEAN：双精度符点数类型 IGNORE：忽略类型映射 不推荐直接使用。

OSS_CREDENTIALS_PROVIDER_KEY_ID - Static variable in class com.aliyun.odps.udf.impl.Constants

OSS_CREDENTIALS_PROVIDER_KEY_SECRET - Static variable in class com.aliyun.odps.udf.impl.Constants

OSS_CREDENTIALS_PROVIDER_TOKEN - Static variable in class com.aliyun.odps.udf.impl.Constants

OSS_CREDENTIALS_PROVIDER_TOKEN_EXPIRE_TIME - Static variable in class com.aliyun.odps.udf.impl.Constants

output(Record) - Method in class com.aliyun.odps.udf.Outputer

Interface for writing a record via output stream.

output(VectorSchemaRoot) - Method in class com.aliyun.odps.udf.VectorizedOutputer

Interface for write

Outputer - Class in com.aliyun.odps.udf

Base outputer class, custom outputer shall extend from this class

Outputer() - Constructor for class com.aliyun.odps.udf.Outputer

OutputFormat - Interface in com.aliyun.odps.udf

TODO: see if we can remove this OutputFormat describes the output-specification

OutputStreamSet - Interface in com.aliyun.odps.io

Encapsulation class that hosts a collection of output streams.

P

parse(Class<?>) - Static method in class com.aliyun.odps.udf.impl.AnnotationParser

ParseError(Throwable) - Constructor for exception com.aliyun.odps.udf.impl.AnnotationParser.ParseError

ParseError(String) - Constructor for exception com.aliyun.odps.udf.impl.AnnotationParser.ParseError

parseOutputSubDirectoriesFromMeta(String) - Static method in class com.aliyun.odps.io.IoUtils

Get valid directories for unstructured data output by ODPS.

ParseResult() - Constructor for class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

planInputSplits(InputSplitter.SplitStrategy) - Method in interface com.aliyun.odps.udf.InputSplitter

PreferWritable - Annotation Type in com.aliyun.odps.udf.annotation

process(Object[]) - Method in class com.aliyun.odps.udf.UDTF

用户代码必须实现UDTF.process(Object[])方法。

progress() - Method in class com.aliyun.odps.exec.ExecutionContextReporter

progress() - Method in interface com.aliyun.odps.exec.Reporter

Report progress to the framework.

Prototype() - Constructor for class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

R

read(byte[], int, int) - Method in class com.aliyun.odps.io.SourceInputStream

Reads some number of bytes from the input stream and stores them into the buffer array b.

read(byte[]) - Method in class com.aliyun.odps.io.SourceInputStream

Reads some number of bytes from the input stream and stores them into the buffer array b.

read() - Method in class com.aliyun.odps.io.SourceInputStream

Read one byte from stream.

READ_ALL_COLUMNS - Static variable in class com.aliyun.odps.serde.SerdeConstants

readCacheArchiveAsStream(String) - Method in class com.aliyun.odps.udf.ExecutionContext

读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.

readCacheArchiveAsStream(String, String) - Method in class com.aliyun.odps.udf.ExecutionContext

读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.

readResourceFile(String) - Method in class com.aliyun.odps.udf.ExecutionContext

读取文件类型资源，一次全部读取到内存，返回 byte[].

readResourceFileAsStream(String) - Method in class com.aliyun.odps.udf.ExecutionContext

读取文件类型资源，返回一个带缓存的输入流。

readResourceTable(String) - Method in class com.aliyun.odps.udf.ExecutionContext

Deprecated.

readToEnd(byte[]) - Method in class com.aliyun.odps.io.SourceInputStream

An attempt to read rest of file content from current position (init to begin of file) to the end of current file split (when file is not split up, it will read the entire file) into the supplied buffer.

RecordReader - Interface in com.aliyun.odps.udf

RecordReader converts the byte-oriented view of the input, provided by the InputSplit, and presents a record-oriented Writable (which will usually de-serialized into Record by an implementation of RecordSerDe ).

RecordSerDe - Class in com.aliyun.odps.udf

SerDe interface for ODPS record to and from Writable

RecordSerDe() - Constructor for class com.aliyun.odps.udf.RecordSerDe

RecordWriter - Interface in com.aliyun.odps.udf

RecordWriter writes the output Writable record (usually serialized by an implementation of RecordSerDe)to output.

Reporter - Interface in com.aliyun.odps.exec

reset() - Method in class com.aliyun.odps.io.SourceInputStream

reset() - Method in interface com.aliyun.odps.udf.Statistics

Resolve - Annotation Type in com.aliyun.odps.udf.annotation

用于指定UDTF的输入输出类型。

resolve(OdpsType[]) - Method in class com.aliyun.odps.udf.UDTF

Deprecated.

resolve(TypeInfo[]) - Method in class com.aliyun.odps.udf.UDTF

用于输入、输出类型 TypeInfo 之间的转换，默认调用 UDTF.resolve(OdpsType[]) 不存在转换问题通常不需要关心。

RowExpression - Class in com.aliyun.odps.udf

RowExpression() - Constructor for class com.aliyun.odps.udf.RowExpression

run() - Method in class com.aliyun.odps.udf.StandaloneUDTF

run方法默认实现，每拉一条记录，调用一次process方法。

S

SerdeConstants - Class in com.aliyun.odps.serde

Corresponding to hive serde properties

SerdeConstants() - Constructor for class com.aliyun.odps.serde.SerdeConstants

SerDeException - Exception in com.aliyun.odps.serde

SerDeException(Throwable) - Constructor for exception com.aliyun.odps.serde.SerDeException

serialize() - Method in interface com.aliyun.odps.udf.CommitMessage

serialize() - Method in interface com.aliyun.odps.udf.InputSplit

serialize(Record) - Method in class com.aliyun.odps.udf.RecordSerDe

Serialize a ODPS record into Writable Writable.

setArguments(OdpsType[]) - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

setCollector(UDTFCollector) - Method in class com.aliyun.odps.udf.UDTF

设置 UDTFCollector，以便该 UDTFCollector 对象与 UDTF 实例相关联。
由于 UDTF 可能会在 UDTFCollector 构造之前被初始化，所以不能在 UDTF 的构造函数中指定 UDTFCollector 。

setRemainingExpr(TreeNode) - Method in class com.aliyun.odps.udf.RowExpression

setRemainingPredicate(RowExpression) - Method in interface com.aliyun.odps.udf.InputSplitter

setRemainingPredicate(RowExpression) - Method in class com.aliyun.odps.udf.VectorizedExtractor

setReturns(OdpsType[]) - Method in class com.aliyun.odps.udf.impl.AnnotationParser.Prototype

setSplitInBytes(long) - Method in class com.aliyun.odps.udf.InputSplitter.SplitStrategy

setStatus(String) - Method in class com.aliyun.odps.exec.ExecutionContextReporter

setStatus(String) - Method in interface com.aliyun.odps.exec.Reporter

Set the status description for the task.

setTp(List<AnnotationParser.Prototype>) - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

setup(ExecutionContext) - Method in class com.aliyun.odps.udf.Aggregator

初始化工作。包括一些共享资源的载入等。 只在初始时被调用，建议一次性的操作都写入本方法。 资源载入通过 ExecutionContext 完成

setup(ExecutionContext, DataAttributes) - Method in interface com.aliyun.odps.udf.Committer

setup(ExecutionContext) - Method in interface com.aliyun.odps.udf.ContextFunction

setup(ExecutionContext, InputStreamSet, DataAttributes) - Method in class com.aliyun.odps.udf.Extractor

Interface for setting up the extractor, implementation can be a no-op

setup(List<String>, DataAttributes) - Method in interface com.aliyun.odps.udf.InputSplitter

setup(ExecutionContext, OutputStreamSet, DataAttributes) - Method in class com.aliyun.odps.udf.Outputer

Interface for setting up the outputer

setup(ExecutionContext) - Method in class com.aliyun.odps.udf.UDF

setup(ExecutionContext, DataAttributes) - Method in class com.aliyun.odps.udf.UDJ

Interface for setting up the udj, implementation can be a no-op

setup(ExecutionContext) - Method in class com.aliyun.odps.udf.UDTF

在UDTF运行期，在每个Worker内UDTF.setup(ExecutionContext)会被先调用一次。

setup(ExecutionContext, InputSplit, DataAttributes) - Method in class com.aliyun.odps.udf.VectorizedExtractor

setup(ExecutionContext, DataAttributes) - Method in class com.aliyun.odps.udf.VectorizedOutputer

setVariadic(boolean) - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

setWritable(boolean) - Method in class com.aliyun.odps.udf.impl.AnnotationParser.ParseResult

SinkOutputStream - Class in com.aliyun.odps.io

An extension of Java OutputStream, used to interface with the output file byte stream.

SinkOutputStream() - Constructor for class com.aliyun.odps.io.SinkOutputStream

skip(long) - Method in class com.aliyun.odps.io.SourceInputStream

SourceInputStream - Class in com.aliyun.odps.io

An extension of Java InputStream used to interface with the input file byte stream

SourceInputStream() - Constructor for class com.aliyun.odps.io.SourceInputStream

SplitStrategy() - Constructor for class com.aliyun.odps.udf.InputSplitter.SplitStrategy

StandaloneUDTF - Class in com.aliyun.odps.udf

具有拉数据功能的UDTF，可以主动调用getNextRow()获取一条记录。 仅在LOT中才能使用，并且有如下限制： 1.

StandaloneUDTF() - Constructor for class com.aliyun.odps.udf.StandaloneUDTF

Statistics - Interface in com.aliyun.odps.udf

T

TableOutputerAttributes - Class in com.aliyun.odps.udf

Provides interface to access outputer-only related attributes.

TableOutputerAttributes() - Constructor for class com.aliyun.odps.udf.TableOutputerAttributes

TableRecordReader - Interface in com.aliyun.odps.udf

terminate(Writable) - Method in class com.aliyun.odps.udf.Aggregator

生成最终结果

toJsonString(Counters) - Static method in class com.aliyun.odps.udf.utils.CounterUtils

将 Counters 对象转化成一个JSON字符串

TypeUtils - Class in com.aliyun.odps.udf.utils

TypeUtils() - Constructor for class com.aliyun.odps.udf.utils.TypeUtils

U

UDF - Class in com.aliyun.odps.udf

UDF 基类 UDF (User Defined Scalar Function) 自定义函数，其输入输出是一对一的关系，即读入一行数据，写出一条输出值。

UDF() - Constructor for class com.aliyun.odps.udf.UDF

UDFException - Exception in com.aliyun.odps.udf

通用的UDF异常类，用于封装UDF运行期间的各种异常。

UDFException(String) - Constructor for exception com.aliyun.odps.udf.UDFException

UDFException(Throwable) - Constructor for exception com.aliyun.odps.udf.UDFException

UdfProperty - Annotation Type in com.aliyun.odps.udf.annotation

UDJ - Class in com.aliyun.odps.udf

UDJ (User Defined Join)

UDJ() - Constructor for class com.aliyun.odps.udf.UDJ

UDTF - Class in com.aliyun.odps.udf

UDTF 是 User Defined Table-generating Function 缩写，用来解决一次函数调用输出多行数据的场景，也是唯一能返回多个字段的自定义函数。

UDTF() - Constructor for class com.aliyun.odps.udf.UDTF

UDTFCollector - Interface in com.aliyun.odps.udf

从UDTF数据源收集数据 通常 UDTF.forward(Object...)会把每一行数据传入UDTFCollector

UDTFPuller - Interface in com.aliyun.odps.udf

V

valueOf(String) - Static method in enum com.aliyun.odps.udf.OdpsType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.aliyun.odps.udf.OdpsType

Returns an array containing the constants of this enum type, in the order they are declared.

VectorizedExtractor - Class in com.aliyun.odps.udf

VectorizedExtractor() - Constructor for class com.aliyun.odps.udf.VectorizedExtractor

VectorizedOutputer - Class in com.aliyun.odps.udf

VectorizedOutputer() - Constructor for class com.aliyun.odps.udf.VectorizedOutputer

VectorizedStorageHandler - Class in com.aliyun.odps.udf

VectorizedStorageHandler() - Constructor for class com.aliyun.odps.udf.VectorizedStorageHandler

verifySchema(OdpsType[]) - Method in class com.aliyun.odps.udf.DataAttributes

Check if the Column schemas passed in by data attributes matched the expectation.

W

write(byte[]) - Method in class com.aliyun.odps.io.SinkOutputStream

Writes b.length bytes from the specified byte array to this output stream

write(byte[], int, int) - Method in class com.aliyun.odps.io.SinkOutputStream

Writes len bytes from the specified byte array starting at offset off to this output stream.

write(int) - Method in class com.aliyun.odps.io.SinkOutputStream

Writes a single byte to the output stream on each invocation, which is very INEFFICIENT, it is not recommend to use this unless it is desirable to write one single byte on each call.

write(Writable) - Method in interface com.aliyun.odps.udf.RecordWriter

Y

yield(E) - Method in interface com.aliyun.odps.Yieldable

Yieldable<E> - Interface in com.aliyun.odps

A B C D E F G H I J L M N O P R S T U V W Y