com.aliyun.oss.model

Class 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectObjectRequest.ExpressionType

Field Summary

Fields inherited from class com.aliyun.oss.model.WebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SelectObjectRequest(String bucketName, String key)

Method Summary

Modifier and Type	Method and Description
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()
long	getMaxSkippedRecordsAllowed()
OutputSerialization	getOutputSerialization() Get the output serialization, it defines the output format
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	setMaxSkippedRecordsAllowed(long maxSkippedRecordsAllowed)
void	setOutputSerialization(OutputSerialization outputSerialization) Set the output serialization, it defines the output format
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	withMaxSkippedRecordsAllowed(long maxSkippedRecordsAllowed)
SelectObjectRequest	withOutputSerialization(OutputSerialization outputSerialization)
SelectObjectRequest	withSelectProgressListener(ProgressListener selectProgressListener)
SelectObjectRequest	withSkipPartialDataRecord(boolean skipPartialDataRecord)
SelectObjectRequest	withSplitRange(long startSplit, long endSplit)

Methods inherited from class com.aliyun.oss.model.GetObjectRequest

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

Methods inherited from class com.aliyun.oss.model.GenericRequest

getBucketName, getKey, getRequestPayer, getVersionId, setBucketName, setKey, setRequestPayer, setVersionId, withBucketName, withKey, withRequestPayer, withVersionId

Methods inherited from class com.aliyun.oss.model.WebServiceRequest

addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getEndpoint, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setEndpoint, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectObjectRequest

public SelectObjectRequest(String bucketName,
                           String key)

Method Detail

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]

Parameters:

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]

Parameters:

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)

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

Returns:

The Base64-encoded SQL statement.

setExpression

public void setExpression(String expression)

Set the expression which used to filter objects

Parameters:

expression - The Base64-encoded SQL statement.

withExpression

public SelectObjectRequest withExpression(String expression)

isSkipPartialDataRecord

public boolean isSkipPartialDataRecord()

setSkipPartialDataRecord

public void setSkipPartialDataRecord(boolean skipPartialDataRecord)

withSkipPartialDataRecord

public SelectObjectRequest withSkipPartialDataRecord(boolean skipPartialDataRecord)

getMaxSkippedRecordsAllowed

public long getMaxSkippedRecordsAllowed()

setMaxSkippedRecordsAllowed

public void setMaxSkippedRecordsAllowed(long maxSkippedRecordsAllowed)

withMaxSkippedRecordsAllowed

public SelectObjectRequest withMaxSkippedRecordsAllowed(long maxSkippedRecordsAllowed)

getExpressionType

public SelectObjectRequest.ExpressionType getExpressionType()

Get the expression type, we only support SQL now.

Returns:

The SelectObjectRequest.ExpressionType

getInputSerialization

public InputSerialization getInputSerialization()

Get the input serialization, we use this to parse data

Returns:

The InputSerialization

setInputSerialization

public void setInputSerialization(InputSerialization inputSerialization)

Set the input serialization, we use this to parse data

Parameters:

inputSerialization - The InputSerialization instance.

withInputSerialization

public SelectObjectRequest withInputSerialization(InputSerialization inputSerialization)

getOutputSerialization

public OutputSerialization getOutputSerialization()

Get the output serialization, it defines the output format

Returns:

The OutputSerialization instance.

setOutputSerialization

public void setOutputSerialization(OutputSerialization outputSerialization)

Set the output serialization, it defines the output format

Parameters:

outputSerialization - The OutputSerialization instance.

withOutputSerialization

public SelectObjectRequest withOutputSerialization(OutputSerialization outputSerialization)

getSelectProgressListener

public ProgressListener getSelectProgressListener()

setSelectProgressListener

public void setSelectProgressListener(ProgressListener selectProgressListener)

withSelectProgressListener

public SelectObjectRequest withSelectProgressListener(ProgressListener selectProgressListener)