public static final class ClientProtos.ScanRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder> implements ClientProtos.ScanRequestOrBuilder
ScanRequest
A scan request. Initially, it should specify a scan. Later on, you can use the scanner id returned to fetch result batches with a different scan request. The scanner will remain open if there are more results, and it's not asked to be closed explicitly. You can fetch the results and ask the scanner to be closed to save a trip if you are not interested in remaining results.
| Modifier and Type | Method and Description |
|---|---|
ClientProtos.ScanRequest |
build() |
ClientProtos.ScanRequest |
buildPartial() |
ClientProtos.ScanRequest.Builder |
clear() |
ClientProtos.ScanRequest.Builder |
clearCloseScanner()
optional bool close_scanner = 5; |
ClientProtos.ScanRequest.Builder |
clearNextCallSeq()
optional uint64 next_call_seq = 6; |
ClientProtos.ScanRequest.Builder |
clearNumberOfRows()
optional uint32 number_of_rows = 4; |
ClientProtos.ScanRequest.Builder |
clearRegion()
optional .RegionSpecifier region = 1; |
ClientProtos.ScanRequest.Builder |
clearScan()
optional .Scan scan = 2; |
ClientProtos.ScanRequest.Builder |
clearScannerId()
optional uint64 scanner_id = 3; |
ClientProtos.ScanRequest.Builder |
clone() |
boolean |
getCloseScanner()
optional bool close_scanner = 5; |
ClientProtos.ScanRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
long |
getNextCallSeq()
optional uint64 next_call_seq = 6; |
int |
getNumberOfRows()
optional uint32 number_of_rows = 4; |
HBaseProtos.RegionSpecifier |
getRegion()
optional .RegionSpecifier region = 1; |
HBaseProtos.RegionSpecifier.Builder |
getRegionBuilder()
optional .RegionSpecifier region = 1; |
HBaseProtos.RegionSpecifierOrBuilder |
getRegionOrBuilder()
optional .RegionSpecifier region = 1; |
ClientProtos.Scan |
getScan()
optional .Scan scan = 2; |
ClientProtos.Scan.Builder |
getScanBuilder()
optional .Scan scan = 2; |
long |
getScannerId()
optional uint64 scanner_id = 3; |
ClientProtos.ScanOrBuilder |
getScanOrBuilder()
optional .Scan scan = 2; |
boolean |
hasCloseScanner()
optional bool close_scanner = 5; |
boolean |
hasNextCallSeq()
optional uint64 next_call_seq = 6; |
boolean |
hasNumberOfRows()
optional uint32 number_of_rows = 4; |
boolean |
hasRegion()
optional .RegionSpecifier region = 1; |
boolean |
hasScan()
optional .Scan scan = 2; |
boolean |
hasScannerId()
optional uint64 scanner_id = 3; |
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ClientProtos.ScanRequest.Builder |
mergeFrom(ClientProtos.ScanRequest other) |
ClientProtos.ScanRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ClientProtos.ScanRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ClientProtos.ScanRequest.Builder |
mergeRegion(HBaseProtos.RegionSpecifier value)
optional .RegionSpecifier region = 1; |
ClientProtos.ScanRequest.Builder |
mergeScan(ClientProtos.Scan value)
optional .Scan scan = 2; |
ClientProtos.ScanRequest.Builder |
setCloseScanner(boolean value)
optional bool close_scanner = 5; |
ClientProtos.ScanRequest.Builder |
setNextCallSeq(long value)
optional uint64 next_call_seq = 6; |
ClientProtos.ScanRequest.Builder |
setNumberOfRows(int value)
optional uint32 number_of_rows = 4; |
ClientProtos.ScanRequest.Builder |
setRegion(HBaseProtos.RegionSpecifier.Builder builderForValue)
optional .RegionSpecifier region = 1; |
ClientProtos.ScanRequest.Builder |
setRegion(HBaseProtos.RegionSpecifier value)
optional .RegionSpecifier region = 1; |
ClientProtos.ScanRequest.Builder |
setScan(ClientProtos.Scan.Builder builderForValue)
optional .Scan scan = 2; |
ClientProtos.ScanRequest.Builder |
setScan(ClientProtos.Scan value)
optional .Scan scan = 2; |
ClientProtos.ScanRequest.Builder |
setScannerId(long value)
optional uint64 scanner_id = 3; |
addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldsfindInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionaddAll, newUninitializedMessageExceptionpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ClientProtos.ScanRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ClientProtos.ScanRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder mergeFrom(ClientProtos.ScanRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<ClientProtos.ScanRequest.Builder>public ClientProtos.ScanRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ClientProtos.ScanRequest.Builder>IOExceptionpublic boolean hasRegion()
optional .RegionSpecifier region = 1;hasRegion in interface ClientProtos.ScanRequestOrBuilderpublic HBaseProtos.RegionSpecifier getRegion()
optional .RegionSpecifier region = 1;getRegion in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier value)
optional .RegionSpecifier region = 1;public ClientProtos.ScanRequest.Builder setRegion(HBaseProtos.RegionSpecifier.Builder builderForValue)
optional .RegionSpecifier region = 1;public ClientProtos.ScanRequest.Builder mergeRegion(HBaseProtos.RegionSpecifier value)
optional .RegionSpecifier region = 1;public ClientProtos.ScanRequest.Builder clearRegion()
optional .RegionSpecifier region = 1;public HBaseProtos.RegionSpecifier.Builder getRegionBuilder()
optional .RegionSpecifier region = 1;public HBaseProtos.RegionSpecifierOrBuilder getRegionOrBuilder()
optional .RegionSpecifier region = 1;getRegionOrBuilder in interface ClientProtos.ScanRequestOrBuilderpublic boolean hasScan()
optional .Scan scan = 2;hasScan in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.Scan getScan()
optional .Scan scan = 2;getScan in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan value)
optional .Scan scan = 2;public ClientProtos.ScanRequest.Builder setScan(ClientProtos.Scan.Builder builderForValue)
optional .Scan scan = 2;public ClientProtos.ScanRequest.Builder mergeScan(ClientProtos.Scan value)
optional .Scan scan = 2;public ClientProtos.ScanRequest.Builder clearScan()
optional .Scan scan = 2;public ClientProtos.Scan.Builder getScanBuilder()
optional .Scan scan = 2;public ClientProtos.ScanOrBuilder getScanOrBuilder()
optional .Scan scan = 2;getScanOrBuilder in interface ClientProtos.ScanRequestOrBuilderpublic boolean hasScannerId()
optional uint64 scanner_id = 3;hasScannerId in interface ClientProtos.ScanRequestOrBuilderpublic long getScannerId()
optional uint64 scanner_id = 3;getScannerId in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setScannerId(long value)
optional uint64 scanner_id = 3;public ClientProtos.ScanRequest.Builder clearScannerId()
optional uint64 scanner_id = 3;public boolean hasNumberOfRows()
optional uint32 number_of_rows = 4;hasNumberOfRows in interface ClientProtos.ScanRequestOrBuilderpublic int getNumberOfRows()
optional uint32 number_of_rows = 4;getNumberOfRows in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setNumberOfRows(int value)
optional uint32 number_of_rows = 4;public ClientProtos.ScanRequest.Builder clearNumberOfRows()
optional uint32 number_of_rows = 4;public boolean hasCloseScanner()
optional bool close_scanner = 5;hasCloseScanner in interface ClientProtos.ScanRequestOrBuilderpublic boolean getCloseScanner()
optional bool close_scanner = 5;getCloseScanner in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setCloseScanner(boolean value)
optional bool close_scanner = 5;public ClientProtos.ScanRequest.Builder clearCloseScanner()
optional bool close_scanner = 5;public boolean hasNextCallSeq()
optional uint64 next_call_seq = 6;hasNextCallSeq in interface ClientProtos.ScanRequestOrBuilderpublic long getNextCallSeq()
optional uint64 next_call_seq = 6;getNextCallSeq in interface ClientProtos.ScanRequestOrBuilderpublic ClientProtos.ScanRequest.Builder setNextCallSeq(long value)
optional uint64 next_call_seq = 6;public ClientProtos.ScanRequest.Builder clearNextCallSeq()
optional uint64 next_call_seq = 6;Copyright © 2014 The Apache Software Foundation. All rights reserved.