Protocol.ReadRequest.Builder (Alluxio Parent 305-SNAPSHOT API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
    - - alluxio.proto.dataserver.Protocol.ReadRequest.Builder

All Implemented Interfaces:

Protocol.ReadRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Protocol.ReadRequest
```
public static final class Protocol.ReadRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
implements Protocol.ReadRequestOrBuilder
```
```
 The read request.
 next available id: 8
 
```
Protobuf type alluxio.proto.dataserver.ReadRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Protocol.ReadRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Protocol.ReadRequest`	`build()`
`Protocol.ReadRequest`	`buildPartial()`
`Protocol.ReadRequest.Builder`	`clear()`
`Protocol.ReadRequest.Builder`	`clearBlockId()` `optional int64 block_id = 1;`
`Protocol.ReadRequest.Builder`	`clearCancel()` If set, this request is to cancel the reading request for the id.
`Protocol.ReadRequest.Builder`	`clearChunkSize()` If set, the server should send packets in the specified packet size.
`Protocol.ReadRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Protocol.ReadRequest.Builder`	`clearLength()` `optional int64 length = 3;`
`Protocol.ReadRequest.Builder`	`clearOffset()` `optional int64 offset = 2;`
`Protocol.ReadRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Protocol.ReadRequest.Builder`	`clearOpenUfsBlockOptions()` This is only set for UFS block read.
`Protocol.ReadRequest.Builder`	`clearPromote()` Whether the block should be promoted before reading
`Protocol.ReadRequest.Builder`	`clone()`
`long`	`getBlockId()` `optional int64 block_id = 1;`
`boolean`	`getCancel()` If set, this request is to cancel the reading request for the id.
`long`	`getChunkSize()` If set, the server should send packets in the specified packet size.
`Protocol.ReadRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getLength()` `optional int64 length = 3;`
`long`	`getOffset()` `optional int64 offset = 2;`
`Protocol.OpenUfsBlockOptions`	`getOpenUfsBlockOptions()` This is only set for UFS block read.
`Protocol.OpenUfsBlockOptions.Builder`	`getOpenUfsBlockOptionsBuilder()` This is only set for UFS block read.
`Protocol.OpenUfsBlockOptionsOrBuilder`	`getOpenUfsBlockOptionsOrBuilder()` This is only set for UFS block read.
`boolean`	`getPromote()` Whether the block should be promoted before reading
`boolean`	`hasBlockId()` `optional int64 block_id = 1;`
`boolean`	`hasCancel()` If set, this request is to cancel the reading request for the id.
`boolean`	`hasChunkSize()` If set, the server should send packets in the specified packet size.
`boolean`	`hasLength()` `optional int64 length = 3;`
`boolean`	`hasOffset()` `optional int64 offset = 2;`
`boolean`	`hasOpenUfsBlockOptions()` This is only set for UFS block read.
`boolean`	`hasPromote()` Whether the block should be promoted before reading
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Protocol.ReadRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Protocol.ReadRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Protocol.ReadRequest.Builder`	`mergeFrom(Protocol.ReadRequest other)`
`Protocol.ReadRequest.Builder`	`mergeOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions value)` This is only set for UFS block read.
`Protocol.ReadRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Protocol.ReadRequest.Builder`	`setBlockId(long value)` `optional int64 block_id = 1;`
`Protocol.ReadRequest.Builder`	`setCancel(boolean value)` If set, this request is to cancel the reading request for the id.
`Protocol.ReadRequest.Builder`	`setChunkSize(long value)` If set, the server should send packets in the specified packet size.
`Protocol.ReadRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Protocol.ReadRequest.Builder`	`setLength(long value)` `optional int64 length = 3;`
`Protocol.ReadRequest.Builder`	`setOffset(long value)` `optional int64 offset = 2;`
`Protocol.ReadRequest.Builder`	`setOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions.Builder builderForValue)` This is only set for UFS block read.
`Protocol.ReadRequest.Builder`	`setOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions value)` This is only set for UFS block read.
`Protocol.ReadRequest.Builder`	`setPromote(boolean value)` Whether the block should be promoted before reading
`Protocol.ReadRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Protocol.ReadRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - clear
```
public Protocol.ReadRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - getDefaultInstanceForType
```
public Protocol.ReadRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Protocol.ReadRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Protocol.ReadRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Protocol.ReadRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - setField
```
public Protocol.ReadRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - clearField
```
public Protocol.ReadRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - clearOneof
```
public Protocol.ReadRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - setRepeatedField
```
public Protocol.ReadRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - addRepeatedField
```
public Protocol.ReadRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - mergeFrom
```
public Protocol.ReadRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protocol.ReadRequest.Builder>
  - mergeFrom
```
public Protocol.ReadRequest.Builder mergeFrom(Protocol.ReadRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - mergeFrom
```
public Protocol.ReadRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Protocol.ReadRequest.Builder>
    
    Throws:
    
    IOException
  - hasBlockId
```
public boolean hasBlockId()
```
    optional int64 block_id = 1;
    
    Specified by:
    
    hasBlockId in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the blockId field is set.
  - getBlockId
```
public long getBlockId()
```
    optional int64 block_id = 1;
    
    Specified by:
    
    getBlockId in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The blockId.
  - setBlockId
```
public Protocol.ReadRequest.Builder setBlockId(long value)
```
    optional int64 block_id = 1;
    
    Parameters:
    
    value - The blockId to set.
    
    Returns:
    
    This builder for chaining.
  - clearBlockId
```
public Protocol.ReadRequest.Builder clearBlockId()
```
    optional int64 block_id = 1;
    
    Returns:
    
    This builder for chaining.
  - hasOffset
```
public boolean hasOffset()
```
    optional int64 offset = 2;
    
    Specified by:
    
    hasOffset in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the offset field is set.
  - getOffset
```
public long getOffset()
```
    optional int64 offset = 2;
    
    Specified by:
    
    getOffset in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The offset.
  - setOffset
```
public Protocol.ReadRequest.Builder setOffset(long value)
```
    optional int64 offset = 2;
    
    Parameters:
    
    value - The offset to set.
    
    Returns:
    
    This builder for chaining.
  - clearOffset
```
public Protocol.ReadRequest.Builder clearOffset()
```
    optional int64 offset = 2;
    
    Returns:
    
    This builder for chaining.
  - hasLength
```
public boolean hasLength()
```
    optional int64 length = 3;
    
    Specified by:
    
    hasLength in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the length field is set.
  - getLength
```
public long getLength()
```
    optional int64 length = 3;
    
    Specified by:
    
    getLength in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The length.
  - setLength
```
public Protocol.ReadRequest.Builder setLength(long value)
```
    optional int64 length = 3;
    
    Parameters:
    
    value - The length to set.
    
    Returns:
    
    This builder for chaining.
  - clearLength
```
public Protocol.ReadRequest.Builder clearLength()
```
    optional int64 length = 3;
    
    Returns:
    
    This builder for chaining.
  - hasCancel
```
public boolean hasCancel()
```
```
 If set, this request is to cancel the reading request for the id.
 
```
    optional bool cancel = 4;
    Specified by:
    
    hasCancel in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the cancel field is set.
  - getCancel
```
public boolean getCancel()
```
```
 If set, this request is to cancel the reading request for the id.
 
```
    optional bool cancel = 4;
    Specified by:
    
    getCancel in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The cancel.
  - setCancel
```
public Protocol.ReadRequest.Builder setCancel(boolean value)
```
```
 If set, this request is to cancel the reading request for the id.
 
```
    optional bool cancel = 4;
    Parameters:
    
    value - The cancel to set.
    
    Returns:
    
    This builder for chaining.
  - clearCancel
```
public Protocol.ReadRequest.Builder clearCancel()
```
```
 If set, this request is to cancel the reading request for the id.
 
```
    optional bool cancel = 4;
    Returns:
    
    This builder for chaining.
  - hasPromote
```
public boolean hasPromote()
```
```
 Whether the block should be promoted before reading
 
```
    optional bool promote = 7;
    Specified by:
    
    hasPromote in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the promote field is set.
  - getPromote
```
public boolean getPromote()
```
```
 Whether the block should be promoted before reading
 
```
    optional bool promote = 7;
    Specified by:
    
    getPromote in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The promote.
  - setPromote
```
public Protocol.ReadRequest.Builder setPromote(boolean value)
```
```
 Whether the block should be promoted before reading
 
```
    optional bool promote = 7;
    Parameters:
    
    value - The promote to set.
    
    Returns:
    
    This builder for chaining.
  - clearPromote
```
public Protocol.ReadRequest.Builder clearPromote()
```
```
 Whether the block should be promoted before reading
 
```
    optional bool promote = 7;
    Returns:
    
    This builder for chaining.
  - hasChunkSize
```
public boolean hasChunkSize()
```
```
 If set, the server should send packets in the specified packet size.
 
```
    optional int64 chunk_size = 5;
    Specified by:
    
    hasChunkSize in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the chunkSize field is set.
  - getChunkSize
```
public long getChunkSize()
```
```
 If set, the server should send packets in the specified packet size.
 
```
    optional int64 chunk_size = 5;
    Specified by:
    
    getChunkSize in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The chunkSize.
  - setChunkSize
```
public Protocol.ReadRequest.Builder setChunkSize(long value)
```
```
 If set, the server should send packets in the specified packet size.
 
```
    optional int64 chunk_size = 5;
    Parameters:
    
    value - The chunkSize to set.
    
    Returns:
    
    This builder for chaining.
  - clearChunkSize
```
public Protocol.ReadRequest.Builder clearChunkSize()
```
```
 If set, the server should send packets in the specified packet size.
 
```
    optional int64 chunk_size = 5;
    Returns:
    
    This builder for chaining.
  - hasOpenUfsBlockOptions
```
public boolean hasOpenUfsBlockOptions()
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
    Specified by:
    
    hasOpenUfsBlockOptions in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    Whether the openUfsBlockOptions field is set.
  - getOpenUfsBlockOptions
```
public Protocol.OpenUfsBlockOptions getOpenUfsBlockOptions()
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
    Specified by:
    
    getOpenUfsBlockOptions in interface Protocol.ReadRequestOrBuilder
    
    Returns:
    
    The openUfsBlockOptions.
  - setOpenUfsBlockOptions
```
public Protocol.ReadRequest.Builder setOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions value)
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
  - setOpenUfsBlockOptions
```
public Protocol.ReadRequest.Builder setOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions.Builder builderForValue)
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
  - mergeOpenUfsBlockOptions
```
public Protocol.ReadRequest.Builder mergeOpenUfsBlockOptions(Protocol.OpenUfsBlockOptions value)
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
  - clearOpenUfsBlockOptions
```
public Protocol.ReadRequest.Builder clearOpenUfsBlockOptions()
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
  - getOpenUfsBlockOptionsBuilder
```
public Protocol.OpenUfsBlockOptions.Builder getOpenUfsBlockOptionsBuilder()
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
  - getOpenUfsBlockOptionsOrBuilder
```
public Protocol.OpenUfsBlockOptionsOrBuilder getOpenUfsBlockOptionsOrBuilder()
```
```
 This is only set for UFS block read.
 
```
    optional .alluxio.proto.dataserver.OpenUfsBlockOptions open_ufs_block_options = 6;
    Specified by:
    
    getOpenUfsBlockOptionsOrBuilder in interface Protocol.ReadRequestOrBuilder
  - setUnknownFields
```
public final Protocol.ReadRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>
  - mergeUnknownFields
```
public final Protocol.ReadRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Protocol.ReadRequest.Builder>

Class Protocol.ReadRequest.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasBlockId

getBlockId

setBlockId

clearBlockId

hasOffset

getOffset

setOffset

clearOffset

hasLength

getLength

setLength

clearLength

hasCancel

getCancel

setCancel

clearCancel

hasPromote

getPromote

setPromote

clearPromote

hasChunkSize

getChunkSize

setChunkSize

clearChunkSize

hasOpenUfsBlockOptions

getOpenUfsBlockOptions

setOpenUfsBlockOptions

setOpenUfsBlockOptions

mergeOpenUfsBlockOptions

clearOpenUfsBlockOptions

getOpenUfsBlockOptionsBuilder

getOpenUfsBlockOptionsOrBuilder

setUnknownFields

mergeUnknownFields