UfsReadOptions.Builder (Alluxio Parent 2.9.4-SNAPSHOT API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<UfsReadOptions.Builder>
    - - alluxio.grpc.UfsReadOptions.Builder

All Implemented Interfaces:

UfsReadOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

UfsReadOptions
```
public static final class UfsReadOptions.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UfsReadOptions.Builder>
implements UfsReadOptionsOrBuilder
```
Protobuf type alluxio.grpc.block.UfsReadOptions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UfsReadOptions.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UfsReadOptions`	`build()`
`UfsReadOptions`	`buildPartial()`
`UfsReadOptions.Builder`	`clear()`
`UfsReadOptions.Builder`	`clearBandwidth()` `optional int64 bandwidth = 3;`
`UfsReadOptions.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`UfsReadOptions.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`UfsReadOptions.Builder`	`clearPositionShort()` is position short or not, used for HDFS performance optimization.
`UfsReadOptions.Builder`	`clearTag()` `required string tag = 1;`
`UfsReadOptions.Builder`	`clearUser()` `optional string user = 4;`
`UfsReadOptions.Builder`	`clone()`
`long`	`getBandwidth()` `optional int64 bandwidth = 3;`
`UfsReadOptions`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getPositionShort()` is position short or not, used for HDFS performance optimization.
`String`	`getTag()` `required string tag = 1;`
`com.google.protobuf.ByteString`	`getTagBytes()` `required string tag = 1;`
`String`	`getUser()` `optional string user = 4;`
`com.google.protobuf.ByteString`	`getUserBytes()` `optional string user = 4;`
`boolean`	`hasBandwidth()` `optional int64 bandwidth = 3;`
`boolean`	`hasPositionShort()` is position short or not, used for HDFS performance optimization.
`boolean`	`hasTag()` `required string tag = 1;`
`boolean`	`hasUser()` `optional string user = 4;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`UfsReadOptions.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`UfsReadOptions.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`UfsReadOptions.Builder`	`mergeFrom(UfsReadOptions other)`
`UfsReadOptions.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UfsReadOptions.Builder`	`setBandwidth(long value)` `optional int64 bandwidth = 3;`
`UfsReadOptions.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UfsReadOptions.Builder`	`setPositionShort(boolean value)` is position short or not, used for HDFS performance optimization.
`UfsReadOptions.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`UfsReadOptions.Builder`	`setTag(String value)` `required string tag = 1;`
`UfsReadOptions.Builder`	`setTagBytes(com.google.protobuf.ByteString value)` `required string tag = 1;`
`UfsReadOptions.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UfsReadOptions.Builder`	`setUser(String value)` `optional string user = 4;`
`UfsReadOptions.Builder`	`setUserBytes(com.google.protobuf.ByteString value)` `optional string user = 4;`

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<UfsReadOptions.Builder>
  - clear
```
public UfsReadOptions.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<UfsReadOptions.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<UfsReadOptions.Builder>
  - getDefaultInstanceForType
```
public UfsReadOptions getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public UfsReadOptions build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public UfsReadOptions buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - setField
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - clearField
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - clearOneof
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - setRepeatedField
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - addRepeatedField
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - mergeFrom
```
public UfsReadOptions.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<UfsReadOptions.Builder>
  - mergeFrom
```
public UfsReadOptions.Builder mergeFrom(UfsReadOptions other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UfsReadOptions.Builder>
  - mergeFrom
```
public UfsReadOptions.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<UfsReadOptions.Builder>
    
    Throws:
    
    IOException
  - hasTag
```
public boolean hasTag()
```
    required string tag = 1;
    
    Specified by:
    
    hasTag in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    Whether the tag field is set.
  - getTag
```
public String getTag()
```
    required string tag = 1;
    
    Specified by:
    
    getTag in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The tag.
  - getTagBytes
```
public com.google.protobuf.ByteString getTagBytes()
```
    required string tag = 1;
    
    Specified by:
    
    getTagBytes in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The bytes for tag.
  - setTag
```
public UfsReadOptions.Builder setTag(String value)
```
    required string tag = 1;
    
    Parameters:
    
    value - The tag to set.
    
    Returns:
    
    This builder for chaining.
  - clearTag
```
public UfsReadOptions.Builder clearTag()
```
    required string tag = 1;
    
    Returns:
    
    This builder for chaining.
  - setTagBytes
```
public UfsReadOptions.Builder setTagBytes(com.google.protobuf.ByteString value)
```
    required string tag = 1;
    
    Parameters:
    
    value - The bytes for tag to set.
    
    Returns:
    
    This builder for chaining.
  - hasPositionShort
```
public boolean hasPositionShort()
```
```
 is position short or not, used for HDFS performance optimization.
 When the client buffer size is large ( > 2MB) and reads are guaranteed to be somewhat
 sequential, the `pread` API to HDFS is not as efficient as simple `read`.
 We introduce a heuristic to choose which API to use.
 
```
    required bool position_short = 2;
    Specified by:
    
    hasPositionShort in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    Whether the positionShort field is set.
  - getPositionShort
```
public boolean getPositionShort()
```
```
 is position short or not, used for HDFS performance optimization.
 When the client buffer size is large ( > 2MB) and reads are guaranteed to be somewhat
 sequential, the `pread` API to HDFS is not as efficient as simple `read`.
 We introduce a heuristic to choose which API to use.
 
```
    required bool position_short = 2;
    Specified by:
    
    getPositionShort in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The positionShort.
  - setPositionShort
```
public UfsReadOptions.Builder setPositionShort(boolean value)
```
```
 is position short or not, used for HDFS performance optimization.
 When the client buffer size is large ( > 2MB) and reads are guaranteed to be somewhat
 sequential, the `pread` API to HDFS is not as efficient as simple `read`.
 We introduce a heuristic to choose which API to use.
 
```
    required bool position_short = 2;
    Parameters:
    
    value - The positionShort to set.
    
    Returns:
    
    This builder for chaining.
  - clearPositionShort
```
public UfsReadOptions.Builder clearPositionShort()
```
```
 is position short or not, used for HDFS performance optimization.
 When the client buffer size is large ( > 2MB) and reads are guaranteed to be somewhat
 sequential, the `pread` API to HDFS is not as efficient as simple `read`.
 We introduce a heuristic to choose which API to use.
 
```
    required bool position_short = 2;
    Returns:
    
    This builder for chaining.
  - hasBandwidth
```
public boolean hasBandwidth()
```
    optional int64 bandwidth = 3;
    
    Specified by:
    
    hasBandwidth in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    Whether the bandwidth field is set.
  - getBandwidth
```
public long getBandwidth()
```
    optional int64 bandwidth = 3;
    
    Specified by:
    
    getBandwidth in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The bandwidth.
  - setBandwidth
```
public UfsReadOptions.Builder setBandwidth(long value)
```
    optional int64 bandwidth = 3;
    
    Parameters:
    
    value - The bandwidth to set.
    
    Returns:
    
    This builder for chaining.
  - clearBandwidth
```
public UfsReadOptions.Builder clearBandwidth()
```
    optional int64 bandwidth = 3;
    
    Returns:
    
    This builder for chaining.
  - hasUser
```
public boolean hasUser()
```
    optional string user = 4;
    
    Specified by:
    
    hasUser in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    Whether the user field is set.
  - getUser
```
public String getUser()
```
    optional string user = 4;
    
    Specified by:
    
    getUser in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The user.
  - getUserBytes
```
public com.google.protobuf.ByteString getUserBytes()
```
    optional string user = 4;
    
    Specified by:
    
    getUserBytes in interface UfsReadOptionsOrBuilder
    
    Returns:
    
    The bytes for user.
  - setUser
```
public UfsReadOptions.Builder setUser(String value)
```
    optional string user = 4;
    
    Parameters:
    
    value - The user to set.
    
    Returns:
    
    This builder for chaining.
  - clearUser
```
public UfsReadOptions.Builder clearUser()
```
    optional string user = 4;
    
    Returns:
    
    This builder for chaining.
  - setUserBytes
```
public UfsReadOptions.Builder setUserBytes(com.google.protobuf.ByteString value)
```
    optional string user = 4;
    
    Parameters:
    
    value - The bytes for user to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final UfsReadOptions.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<UfsReadOptions.Builder>
  - mergeUnknownFields
```
public final UfsReadOptions.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<UfsReadOptions.Builder>

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

hasTag

getTag

getTagBytes

setTag

clearTag

setTagBytes

hasPositionShort

getPositionShort

setPositionShort

clearPositionShort

hasBandwidth

getBandwidth

setBandwidth

clearBandwidth

hasUser

getUser

getUserBytes

setUser

clearUser

setUserBytes

setUnknownFields

mergeUnknownFields