ClientPB.ScanRequest.Builder (Asynchronous HBase Client 1.8.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
- - com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
  - - org.hbase.async.generated.ClientPB.ScanRequest.Builder

All Implemented Interfaces:: com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable, ClientPB.ScanRequestOrBuilder

Enclosing class:: ClientPB.ScanRequest

public static final class ClientPB.ScanRequest.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
implements ClientPB.ScanRequestOrBuilder

Protobuf type 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientPB.ScanRequest`	`build()`
`ClientPB.ScanRequest`	`buildPartial()`
`ClientPB.ScanRequest.Builder`	`clear()`
`ClientPB.ScanRequest.Builder`	`clearClientHandlesHeartbeats()` `optional bool client_handles_heartbeats = 8;`
`ClientPB.ScanRequest.Builder`	`clearClientHandlesPartials()` `optional bool client_handles_partials = 7;`
`ClientPB.ScanRequest.Builder`	`clearCloseScanner()` `optional bool close_scanner = 5;`
`ClientPB.ScanRequest.Builder`	`clearNextCallSeq()` `optional uint64 next_call_seq = 6;`
`ClientPB.ScanRequest.Builder`	`clearNumberOfRows()` `optional uint32 number_of_rows = 4;`
`ClientPB.ScanRequest.Builder`	`clearRegion()` `optional .RegionSpecifier region = 1;`
`ClientPB.ScanRequest.Builder`	`clearRenew()` `optional bool renew = 10 [default = false];`
`ClientPB.ScanRequest.Builder`	`clearScan()` `optional .Scan scan = 2;`
`ClientPB.ScanRequest.Builder`	`clearScannerId()` `optional uint64 scanner_id = 3;`
`ClientPB.ScanRequest.Builder`	`clearTrackScanMetrics()` `optional bool track_scan_metrics = 9;`
`ClientPB.ScanRequest.Builder`	`clone()`
`boolean`	`getClientHandlesHeartbeats()` `optional bool client_handles_heartbeats = 8;`
`boolean`	`getClientHandlesPartials()` `optional bool client_handles_partials = 7;`
`boolean`	`getCloseScanner()` `optional bool close_scanner = 5;`
`ClientPB.ScanRequest`	`getDefaultInstanceForType()`
`long`	`getNextCallSeq()` `optional uint64 next_call_seq = 6;`
`int`	`getNumberOfRows()` `optional uint32 number_of_rows = 4;`
`HBasePB.RegionSpecifier`	`getRegion()` `optional .RegionSpecifier region = 1;`
`boolean`	`getRenew()` `optional bool renew = 10 [default = false];`
`ClientPB.Scan`	`getScan()` `optional .Scan scan = 2;`
`long`	`getScannerId()` `optional uint64 scanner_id = 3;`
`boolean`	`getTrackScanMetrics()` `optional bool track_scan_metrics = 9;`
`boolean`	`hasClientHandlesHeartbeats()` `optional bool client_handles_heartbeats = 8;`
`boolean`	`hasClientHandlesPartials()` `optional bool client_handles_partials = 7;`
`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`	`hasRenew()` `optional bool renew = 10 [default = false];`
`boolean`	`hasScan()` `optional .Scan scan = 2;`
`boolean`	`hasScannerId()` `optional uint64 scanner_id = 3;`
`boolean`	`hasTrackScanMetrics()` `optional bool track_scan_metrics = 9;`
`boolean`	`isInitialized()`
`ClientPB.ScanRequest.Builder`	`mergeFrom(ClientPB.ScanRequest other)`
`ClientPB.ScanRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ClientPB.ScanRequest.Builder`	`mergeRegion(HBasePB.RegionSpecifier value)` `optional .RegionSpecifier region = 1;`
`ClientPB.ScanRequest.Builder`	`mergeScan(ClientPB.Scan value)` `optional .Scan scan = 2;`
`ClientPB.ScanRequest.Builder`	`setClientHandlesHeartbeats(boolean value)` `optional bool client_handles_heartbeats = 8;`
`ClientPB.ScanRequest.Builder`	`setClientHandlesPartials(boolean value)` `optional bool client_handles_partials = 7;`
`ClientPB.ScanRequest.Builder`	`setCloseScanner(boolean value)` `optional bool close_scanner = 5;`
`ClientPB.ScanRequest.Builder`	`setNextCallSeq(long value)` `optional uint64 next_call_seq = 6;`
`ClientPB.ScanRequest.Builder`	`setNumberOfRows(int value)` `optional uint32 number_of_rows = 4;`
`ClientPB.ScanRequest.Builder`	`setRegion(HBasePB.RegionSpecifier.Builder builderForValue)` `optional .RegionSpecifier region = 1;`
`ClientPB.ScanRequest.Builder`	`setRegion(HBasePB.RegionSpecifier value)` `optional .RegionSpecifier region = 1;`
`ClientPB.ScanRequest.Builder`	`setRenew(boolean value)` `optional bool renew = 10 [default = false];`
`ClientPB.ScanRequest.Builder`	`setScan(ClientPB.Scan.Builder builderForValue)` `optional .Scan scan = 2;`
`ClientPB.ScanRequest.Builder`	`setScan(ClientPB.Scan value)` `optional .Scan scan = 2;`
`ClientPB.ScanRequest.Builder`	`setScannerId(long value)` `optional uint64 scanner_id = 3;`
`ClientPB.ScanRequest.Builder`	`setTrackScanMetrics(boolean value)` `optional bool track_scan_metrics = 9;`

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - clear
```
public ClientPB.ScanRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
  - clone
```
public ClientPB.ScanRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
  - getDefaultInstanceForType
```
public ClientPB.ScanRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    getDefaultInstanceForType in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
  - build
```
public ClientPB.ScanRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ClientPB.ScanRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public ClientPB.ScanRequest.Builder mergeFrom(ClientPB.ScanRequest other)
```
    Specified by:
    
    mergeFrom in class com.google.protobuf.GeneratedMessageLite.Builder<ClientPB.ScanRequest,ClientPB.ScanRequest.Builder>
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
  - mergeFrom
```
public ClientPB.ScanRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessageLite.Builder<ClientPB.ScanRequest.Builder>
    
    Throws:
    
    IOException
  - hasRegion
```
public boolean hasRegion()
```
    optional .RegionSpecifier region = 1;
    
    Specified by:
    
    hasRegion in interface ClientPB.ScanRequestOrBuilder
  - getRegion
```
public HBasePB.RegionSpecifier getRegion()
```
    optional .RegionSpecifier region = 1;
    
    Specified by:
    
    getRegion in interface ClientPB.ScanRequestOrBuilder
  - setRegion
```
public ClientPB.ScanRequest.Builder setRegion(HBasePB.RegionSpecifier value)
```
    optional .RegionSpecifier region = 1;
  - setRegion
```
public ClientPB.ScanRequest.Builder setRegion(HBasePB.RegionSpecifier.Builder builderForValue)
```
    optional .RegionSpecifier region = 1;
  - mergeRegion
```
public ClientPB.ScanRequest.Builder mergeRegion(HBasePB.RegionSpecifier value)
```
    optional .RegionSpecifier region = 1;
  - clearRegion
```
public ClientPB.ScanRequest.Builder clearRegion()
```
    optional .RegionSpecifier region = 1;
  - hasScan
```
public boolean hasScan()
```
    optional .Scan scan = 2;
    
    Specified by:
    
    hasScan in interface ClientPB.ScanRequestOrBuilder
  - getScan
```
public ClientPB.Scan getScan()
```
    optional .Scan scan = 2;
    
    Specified by:
    
    getScan in interface ClientPB.ScanRequestOrBuilder
  - setScan
```
public ClientPB.ScanRequest.Builder setScan(ClientPB.Scan value)
```
    optional .Scan scan = 2;
  - setScan
```
public ClientPB.ScanRequest.Builder setScan(ClientPB.Scan.Builder builderForValue)
```
    optional .Scan scan = 2;
  - mergeScan
```
public ClientPB.ScanRequest.Builder mergeScan(ClientPB.Scan value)
```
    optional .Scan scan = 2;
  - clearScan
```
public ClientPB.ScanRequest.Builder clearScan()
```
    optional .Scan scan = 2;
  - hasScannerId
```
public boolean hasScannerId()
```
    optional uint64 scanner_id = 3;
    
    Specified by:
    
    hasScannerId in interface ClientPB.ScanRequestOrBuilder
  - getScannerId
```
public long getScannerId()
```
    optional uint64 scanner_id = 3;
    
    Specified by:
    
    getScannerId in interface ClientPB.ScanRequestOrBuilder
  - setScannerId
```
public ClientPB.ScanRequest.Builder setScannerId(long value)
```
    optional uint64 scanner_id = 3;
  - clearScannerId
```
public ClientPB.ScanRequest.Builder clearScannerId()
```
    optional uint64 scanner_id = 3;
  - hasNumberOfRows
```
public boolean hasNumberOfRows()
```
    optional uint32 number_of_rows = 4;
    
    Specified by:
    
    hasNumberOfRows in interface ClientPB.ScanRequestOrBuilder
  - getNumberOfRows
```
public int getNumberOfRows()
```
    optional uint32 number_of_rows = 4;
    
    Specified by:
    
    getNumberOfRows in interface ClientPB.ScanRequestOrBuilder
  - setNumberOfRows
```
public ClientPB.ScanRequest.Builder setNumberOfRows(int value)
```
    optional uint32 number_of_rows = 4;
  - clearNumberOfRows
```
public ClientPB.ScanRequest.Builder clearNumberOfRows()
```
    optional uint32 number_of_rows = 4;
  - hasCloseScanner
```
public boolean hasCloseScanner()
```
    optional bool close_scanner = 5;
    
    Specified by:
    
    hasCloseScanner in interface ClientPB.ScanRequestOrBuilder
  - getCloseScanner
```
public boolean getCloseScanner()
```
    optional bool close_scanner = 5;
    
    Specified by:
    
    getCloseScanner in interface ClientPB.ScanRequestOrBuilder
  - setCloseScanner
```
public ClientPB.ScanRequest.Builder setCloseScanner(boolean value)
```
    optional bool close_scanner = 5;
  - clearCloseScanner
```
public ClientPB.ScanRequest.Builder clearCloseScanner()
```
    optional bool close_scanner = 5;
  - hasNextCallSeq
```
public boolean hasNextCallSeq()
```
    optional uint64 next_call_seq = 6;
    
    Specified by:
    
    hasNextCallSeq in interface ClientPB.ScanRequestOrBuilder
  - getNextCallSeq
```
public long getNextCallSeq()
```
    optional uint64 next_call_seq = 6;
    
    Specified by:
    
    getNextCallSeq in interface ClientPB.ScanRequestOrBuilder
  - setNextCallSeq
```
public ClientPB.ScanRequest.Builder setNextCallSeq(long value)
```
    optional uint64 next_call_seq = 6;
  - clearNextCallSeq
```
public ClientPB.ScanRequest.Builder clearNextCallSeq()
```
    optional uint64 next_call_seq = 6;
  - hasClientHandlesPartials
```
public boolean hasClientHandlesPartials()
```
    optional bool client_handles_partials = 7;
    
    Specified by:
    
    hasClientHandlesPartials in interface ClientPB.ScanRequestOrBuilder
  - getClientHandlesPartials
```
public boolean getClientHandlesPartials()
```
    optional bool client_handles_partials = 7;
    
    Specified by:
    
    getClientHandlesPartials in interface ClientPB.ScanRequestOrBuilder
  - setClientHandlesPartials
```
public ClientPB.ScanRequest.Builder setClientHandlesPartials(boolean value)
```
    optional bool client_handles_partials = 7;
  - clearClientHandlesPartials
```
public ClientPB.ScanRequest.Builder clearClientHandlesPartials()
```
    optional bool client_handles_partials = 7;
  - hasClientHandlesHeartbeats
```
public boolean hasClientHandlesHeartbeats()
```
    optional bool client_handles_heartbeats = 8;
    
    Specified by:
    
    hasClientHandlesHeartbeats in interface ClientPB.ScanRequestOrBuilder
  - getClientHandlesHeartbeats
```
public boolean getClientHandlesHeartbeats()
```
    optional bool client_handles_heartbeats = 8;
    
    Specified by:
    
    getClientHandlesHeartbeats in interface ClientPB.ScanRequestOrBuilder
  - setClientHandlesHeartbeats
```
public ClientPB.ScanRequest.Builder setClientHandlesHeartbeats(boolean value)
```
    optional bool client_handles_heartbeats = 8;
  - clearClientHandlesHeartbeats
```
public ClientPB.ScanRequest.Builder clearClientHandlesHeartbeats()
```
    optional bool client_handles_heartbeats = 8;
  - hasTrackScanMetrics
```
public boolean hasTrackScanMetrics()
```
    optional bool track_scan_metrics = 9;
    
    Specified by:
    
    hasTrackScanMetrics in interface ClientPB.ScanRequestOrBuilder
  - getTrackScanMetrics
```
public boolean getTrackScanMetrics()
```
    optional bool track_scan_metrics = 9;
    
    Specified by:
    
    getTrackScanMetrics in interface ClientPB.ScanRequestOrBuilder
  - setTrackScanMetrics
```
public ClientPB.ScanRequest.Builder setTrackScanMetrics(boolean value)
```
    optional bool track_scan_metrics = 9;
  - clearTrackScanMetrics
```
public ClientPB.ScanRequest.Builder clearTrackScanMetrics()
```
    optional bool track_scan_metrics = 9;
  - hasRenew
```
public boolean hasRenew()
```
    optional bool renew = 10 [default = false];
    
    Specified by:
    
    hasRenew in interface ClientPB.ScanRequestOrBuilder
  - getRenew
```
public boolean getRenew()
```
    optional bool renew = 10 [default = false];
    
    Specified by:
    
    getRenew in interface ClientPB.ScanRequestOrBuilder
  - setRenew
```
public ClientPB.ScanRequest.Builder setRenew(boolean value)
```
    optional bool renew = 10 [default = false];
  - clearRenew
```
public ClientPB.ScanRequest.Builder clearRenew()
```
    optional bool renew = 10 [default = false];

Class ClientPB.ScanRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Method Detail

clear

clone

getDefaultInstanceForType

build

buildPartial

mergeFrom

isInitialized

mergeFrom

hasRegion

getRegion

setRegion

setRegion

mergeRegion

clearRegion

hasScan

getScan

setScan

setScan

mergeScan

clearScan

hasScannerId

getScannerId

setScannerId

clearScannerId

hasNumberOfRows

getNumberOfRows

setNumberOfRows

clearNumberOfRows

hasCloseScanner

getCloseScanner

setCloseScanner

clearCloseScanner

hasNextCallSeq

getNextCallSeq

setNextCallSeq

clearNextCallSeq

hasClientHandlesPartials

getClientHandlesPartials

setClientHandlesPartials

clearClientHandlesPartials

hasClientHandlesHeartbeats

getClientHandlesHeartbeats

setClientHandlesHeartbeats

clearClientHandlesHeartbeats

hasTrackScanMetrics

getTrackScanMetrics

setTrackScanMetrics

clearTrackScanMetrics

hasRenew

getRenew

setRenew

clearRenew