com.aliyun.oss.model

类 SelectObjectRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.GetObjectRequest

com.aliyun.oss.model.SelectObjectRequest

public class SelectObjectRequest
extends GetObjectRequest

This is the request class that is used to select an object from OSS. It wraps all the information needed to select this object. User can pass sql expression to filter csv objects.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	SelectObjectRequest.ExpressionType

字段概要

从类继承的字段 com.aliyun.oss.model.WebServiceRequest

NOOP

构造器概要

构造器

构造器和说明
SelectObjectRequest(String bucketName, String key)

方法概要

方法

限定符和类型	方法和说明
String	getExpression() Get the expression which used to filter objects
SelectObjectRequest.ExpressionType	getExpressionType() Get the expression type, we only support SQL now.
InputSerialization	getInputSerialization() Get the input serialization, we use this to parse data
long[]	getLineRange()
OutputSerialization	getOutputSerialization() Get the output serialization, it defines the output format
long[]	getRange() Gets the range of the object to download.
ProgressListener	getSelectProgressListener()
long[]	getSplitRange()
boolean	isSkipPartialDataRecord()
String	lineRangeToString(long[] range)
String	rangeToString(String rangePrefix, long[] range)
void	setExpression(String expression) Set the expression which used to filter objects
void	setInputSerialization(InputSerialization inputSerialization) Set the input serialization, we use this to parse data
void	setLineRange(long startLine, long endLine) For text file, we can define line range for select operations.
void	setOutputSerialization(OutputSerialization outputSerialization) Set the output serialization, it defines the output format
void	setRange(long start, long end) Sets the range of the object to download (optional).
void	setSelectProgressListener(ProgressListener selectProgressListener)
void	setSkipPartialDataRecord(boolean skipPartialDataRecord)
void	setSplitRange(long startSplit, long endSplit) For text file, we can define split range for select operations.
String	splitRangeToString(long[] range)
SelectObjectRequest	withExpression(String expression)
SelectObjectRequest	withInputSerialization(InputSerialization inputSerialization)
SelectObjectRequest	withLineRange(long startLine, long endLine)
SelectObjectRequest	withOutputSerialization(OutputSerialization outputSerialization)
SelectObjectRequest	withSelectProgressListener(ProgressListener selectProgressListener)
SelectObjectRequest	withSkipPartialDataRecord(boolean skipPartialDataRecord)
SelectObjectRequest	withSplitRange(long startSplit, long endSplit)

从类继承的方法 com.aliyun.oss.model.GetObjectRequest

clearMatchingETagConstraints, clearNonmatchingETagConstraints, getAbsoluteUri, getMatchingETagConstraints, getModifiedSinceConstraint, getNonmatchingETagConstraints, getProcess, getResponseHeaders, getUnmodifiedSinceConstraint, isUseUrlSignature, setAbsoluteUri, setMatchingETagConstraints, setModifiedSinceConstraint, setNonmatchingETagConstraints, setProcess, setResponseHeaders, setUnmodifiedSinceConstraint, setUseUrlSignature, withRange

从类继承的方法 com.aliyun.oss.model.GenericRequest

getBucketName, getKey, setBucketName, setKey, withBucketName, withKey

从类继承的方法 com.aliyun.oss.model.WebServiceRequest

addHeader, addParameter, getHeaders, getParameters, getProgressListener, isLogEnabled, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SelectObjectRequest

public SelectObjectRequest(String bucketName,
                   String key)

方法详细资料

getLineRange

public long[] getLineRange()

setLineRange

public void setLineRange(long startLine,
                long endLine)

For text file, we can define line range for select operations. Select will only scan data between startLine and endLine, that is [startLine, endLine] * @param startLine

Start line number

When the start is non-negative, it means the starting line to select. When the start is -1, it means the range is determined by the end only and the end could not be -1. For example, when start is -1 and end is 100. It means the select line range will be the last 100 lines.

参数:

endLine -

End line number

When the end is non-negative, it means the ending line to select. When the end is -1, it means the range is determined by the start only and the start could not be -1. For example, when end is -1 and start is 100. It means the select range will be all exception first 100 lines.

withLineRange

public SelectObjectRequest withLineRange(long startLine,
                                long endLine)

getSplitRange

public long[] getSplitRange()

setSplitRange

public void setSplitRange(long startSplit,
                 long endSplit)

For text file, we can define split range for select operations. Select will only scan data between startSplit and endSplit, that is [startSplit, endSplit]

参数:

startSplit -

Start split number

When the start is non-negative, it means the starting split to select. When the start is -1, it means the range is determined by the end only and the end could not be -1. For example, when start is -1 and end is 100. It means the select split range will be the last 100 splits.

endSplit -

End split number

When the end is non-negative, it means the ending split to select. When the end is -1, it means the range is determined by the start only and the start could not be -1. For example, when end is -1 and start is 100. It means the select range will be all exception first 100 splits.

withSplitRange

public SelectObjectRequest withSplitRange(long startSplit,
                                 long endSplit)

getRange

public long[] getRange()

从类复制的说明: GetObjectRequest

Gets the range of the object to download. The range is in the form of {start, end}---start and end is position of the object's content.

覆盖:

getRange 在类中 GetObjectRequest

返回:

The range of the object to download.

setRange

public void setRange(long start,
            long end)
              throws InvalidParameterException

从类复制的说明: GetObjectRequest

Sets the range of the object to download (optional).

覆盖:

setRange 在类中 GetObjectRequest

参数:

start -

Start position

When the start is non-negative, it means the starting position to download. When the start is -1, it means the range is determined by the end only and the end could not be -1. For example, when start is -1 and end is 100. It means the download range will be the last 100 bytes.

end -

End position

When the end is non-negative, it means the ending position to download. When the end is -1, it means the range is determined by the start only and the start could not be -1. For example, when end is -1 and start is 100. It means the download range will be all exception first 100 bytes.

抛出:

InvalidParameterException

lineRangeToString

public String lineRangeToString(long[] range)

splitRangeToString

public String splitRangeToString(long[] range)

rangeToString

public String rangeToString(String rangePrefix,
                   long[] range)

getExpression

public String getExpression()

Get the expression which used to filter objects

返回:

setExpression

public void setExpression(String expression)

Set the expression which used to filter objects

参数:

expression -

withExpression

public SelectObjectRequest withExpression(String expression)

isSkipPartialDataRecord

public boolean isSkipPartialDataRecord()

setSkipPartialDataRecord

public void setSkipPartialDataRecord(boolean skipPartialDataRecord)

withSkipPartialDataRecord

public SelectObjectRequest withSkipPartialDataRecord(boolean skipPartialDataRecord)

getExpressionType

public SelectObjectRequest.ExpressionType getExpressionType()

Get the expression type, we only support SQL now.

返回:

getInputSerialization

public InputSerialization getInputSerialization()

Get the input serialization, we use this to parse data

返回:

setInputSerialization

public void setInputSerialization(InputSerialization inputSerialization)

Set the input serialization, we use this to parse data

参数:

inputSerialization -

withInputSerialization

public SelectObjectRequest withInputSerialization(InputSerialization inputSerialization)

getOutputSerialization

public OutputSerialization getOutputSerialization()

Get the output serialization, it defines the output format

返回:

setOutputSerialization

public void setOutputSerialization(OutputSerialization outputSerialization)

Set the output serialization, it defines the output format

参数:

outputSerialization -

withOutputSerialization

public SelectObjectRequest withOutputSerialization(OutputSerialization outputSerialization)

getSelectProgressListener

public ProgressListener getSelectProgressListener()

setSelectProgressListener

public void setSelectProgressListener(ProgressListener selectProgressListener)

withSelectProgressListener

public SelectObjectRequest withSelectProgressListener(ProgressListener selectProgressListener)