Protocol.WriteRequest.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.WriteRequest.Builder>
    - - alluxio.proto.dataserver.Protocol.WriteRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Protocol.WriteRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Protocol.WriteRequest`	`build()`
`Protocol.WriteRequest`	`buildPartial()`
`Protocol.WriteRequest.Builder`	`clear()`
`Protocol.WriteRequest.Builder`	`clearCancel()` `optional bool cancel = 6;`
`Protocol.WriteRequest.Builder`	`clearCreateUfsFileOptions()` This is only applicable for ufs writes.
`Protocol.WriteRequest.Builder`	`clearEof()` `optional bool eof = 5;`
`Protocol.WriteRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Protocol.WriteRequest.Builder`	`clearId()` The block ID or UFS file ID.
`Protocol.WriteRequest.Builder`	`clearOffset()` `optional int64 offset = 3;`
`Protocol.WriteRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Protocol.WriteRequest.Builder`	`clearTier()` This is only applicable for block write.
`Protocol.WriteRequest.Builder`	`clearType()` `optional .alluxio.proto.dataserver.RequestType type = 1;`
`Protocol.WriteRequest.Builder`	`clone()`
`boolean`	`getCancel()` `optional bool cancel = 6;`
`Protocol.CreateUfsFileOptions`	`getCreateUfsFileOptions()` This is only applicable for ufs writes.
`Protocol.CreateUfsFileOptions.Builder`	`getCreateUfsFileOptionsBuilder()` This is only applicable for ufs writes.
`Protocol.CreateUfsFileOptionsOrBuilder`	`getCreateUfsFileOptionsOrBuilder()` This is only applicable for ufs writes.
`Protocol.WriteRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getEof()` `optional bool eof = 5;`
`long`	`getId()` The block ID or UFS file ID.
`long`	`getOffset()` `optional int64 offset = 3;`
`int`	`getTier()` This is only applicable for block write.
`Protocol.RequestType`	`getType()` `optional .alluxio.proto.dataserver.RequestType type = 1;`
`boolean`	`hasCancel()` `optional bool cancel = 6;`
`boolean`	`hasCreateUfsFileOptions()` This is only applicable for ufs writes.
`boolean`	`hasEof()` `optional bool eof = 5;`
`boolean`	`hasId()` The block ID or UFS file ID.
`boolean`	`hasOffset()` `optional int64 offset = 3;`
`boolean`	`hasTier()` This is only applicable for block write.
`boolean`	`hasType()` `optional .alluxio.proto.dataserver.RequestType type = 1;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Protocol.WriteRequest.Builder`	`mergeCreateUfsFileOptions(Protocol.CreateUfsFileOptions value)` This is only applicable for ufs writes.
`Protocol.WriteRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Protocol.WriteRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Protocol.WriteRequest.Builder`	`mergeFrom(Protocol.WriteRequest other)`
`Protocol.WriteRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Protocol.WriteRequest.Builder`	`setCancel(boolean value)` `optional bool cancel = 6;`
`Protocol.WriteRequest.Builder`	`setCreateUfsFileOptions(Protocol.CreateUfsFileOptions.Builder builderForValue)` This is only applicable for ufs writes.
`Protocol.WriteRequest.Builder`	`setCreateUfsFileOptions(Protocol.CreateUfsFileOptions value)` This is only applicable for ufs writes.
`Protocol.WriteRequest.Builder`	`setEof(boolean value)` `optional bool eof = 5;`
`Protocol.WriteRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Protocol.WriteRequest.Builder`	`setId(long value)` The block ID or UFS file ID.
`Protocol.WriteRequest.Builder`	`setOffset(long value)` `optional int64 offset = 3;`
`Protocol.WriteRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Protocol.WriteRequest.Builder`	`setTier(int value)` This is only applicable for block write.
`Protocol.WriteRequest.Builder`	`setType(Protocol.RequestType value)` `optional .alluxio.proto.dataserver.RequestType type = 1;`
`Protocol.WriteRequest.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.WriteRequest.Builder>
  - clear
```
public Protocol.WriteRequest.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.WriteRequest.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.WriteRequest.Builder>
  - getDefaultInstanceForType
```
public Protocol.WriteRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Protocol.WriteRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Protocol.WriteRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - setField
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - clearField
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - clearOneof
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - setRepeatedField
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - addRepeatedField
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - mergeFrom
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
  - mergeFrom
```
public Protocol.WriteRequest.Builder mergeFrom(Protocol.WriteRequest 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.WriteRequest.Builder>
  - mergeFrom
```
public Protocol.WriteRequest.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.WriteRequest.Builder>
    
    Throws:
    
    IOException
  - hasType
```
public boolean hasType()
```
    optional .alluxio.proto.dataserver.RequestType type = 1;
    
    Specified by:
    
    hasType in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the type field is set.
  - getType
```
public Protocol.RequestType getType()
```
    optional .alluxio.proto.dataserver.RequestType type = 1;
    
    Specified by:
    
    getType in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The type.
  - setType
```
public Protocol.WriteRequest.Builder setType(Protocol.RequestType value)
```
    optional .alluxio.proto.dataserver.RequestType type = 1;
    
    Parameters:
    
    value - The type to set.
    
    Returns:
    
    This builder for chaining.
  - clearType
```
public Protocol.WriteRequest.Builder clearType()
```
    optional .alluxio.proto.dataserver.RequestType type = 1;
    
    Returns:
    
    This builder for chaining.
  - hasId
```
public boolean hasId()
```
```
 The block ID or UFS file ID.
 
```
    optional int64 id = 2;
    Specified by:
    
    hasId in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the id field is set.
  - getId
```
public long getId()
```
```
 The block ID or UFS file ID.
 
```
    optional int64 id = 2;
    Specified by:
    
    getId in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The id.
  - setId
```
public Protocol.WriteRequest.Builder setId(long value)
```
```
 The block ID or UFS file ID.
 
```
    optional int64 id = 2;
    Parameters:
    
    value - The id to set.
    
    Returns:
    
    This builder for chaining.
  - clearId
```
public Protocol.WriteRequest.Builder clearId()
```
```
 The block ID or UFS file ID.
 
```
    optional int64 id = 2;
    Returns:
    
    This builder for chaining.
  - hasOffset
```
public boolean hasOffset()
```
    optional int64 offset = 3;
    
    Specified by:
    
    hasOffset in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the offset field is set.
  - getOffset
```
public long getOffset()
```
    optional int64 offset = 3;
    
    Specified by:
    
    getOffset in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The offset.
  - setOffset
```
public Protocol.WriteRequest.Builder setOffset(long value)
```
    optional int64 offset = 3;
    
    Parameters:
    
    value - The offset to set.
    
    Returns:
    
    This builder for chaining.
  - clearOffset
```
public Protocol.WriteRequest.Builder clearOffset()
```
    optional int64 offset = 3;
    
    Returns:
    
    This builder for chaining.
  - hasTier
```
public boolean hasTier()
```
```
 This is only applicable for block write.
 
```
    optional int32 tier = 4;
    Specified by:
    
    hasTier in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the tier field is set.
  - getTier
```
public int getTier()
```
```
 This is only applicable for block write.
 
```
    optional int32 tier = 4;
    Specified by:
    
    getTier in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The tier.
  - setTier
```
public Protocol.WriteRequest.Builder setTier(int value)
```
```
 This is only applicable for block write.
 
```
    optional int32 tier = 4;
    Parameters:
    
    value - The tier to set.
    
    Returns:
    
    This builder for chaining.
  - clearTier
```
public Protocol.WriteRequest.Builder clearTier()
```
```
 This is only applicable for block write.
 
```
    optional int32 tier = 4;
    Returns:
    
    This builder for chaining.
  - hasEof
```
public boolean hasEof()
```
    optional bool eof = 5;
    
    Specified by:
    
    hasEof in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the eof field is set.
  - getEof
```
public boolean getEof()
```
    optional bool eof = 5;
    
    Specified by:
    
    getEof in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The eof.
  - setEof
```
public Protocol.WriteRequest.Builder setEof(boolean value)
```
    optional bool eof = 5;
    
    Parameters:
    
    value - The eof to set.
    
    Returns:
    
    This builder for chaining.
  - clearEof
```
public Protocol.WriteRequest.Builder clearEof()
```
    optional bool eof = 5;
    
    Returns:
    
    This builder for chaining.
  - hasCancel
```
public boolean hasCancel()
```
    optional bool cancel = 6;
    
    Specified by:
    
    hasCancel in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the cancel field is set.
  - getCancel
```
public boolean getCancel()
```
    optional bool cancel = 6;
    
    Specified by:
    
    getCancel in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The cancel.
  - setCancel
```
public Protocol.WriteRequest.Builder setCancel(boolean value)
```
    optional bool cancel = 6;
    
    Parameters:
    
    value - The cancel to set.
    
    Returns:
    
    This builder for chaining.
  - clearCancel
```
public Protocol.WriteRequest.Builder clearCancel()
```
    optional bool cancel = 6;
    
    Returns:
    
    This builder for chaining.
  - hasCreateUfsFileOptions
```
public boolean hasCreateUfsFileOptions()
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
    Specified by:
    
    hasCreateUfsFileOptions in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    Whether the createUfsFileOptions field is set.
  - getCreateUfsFileOptions
```
public Protocol.CreateUfsFileOptions getCreateUfsFileOptions()
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
    Specified by:
    
    getCreateUfsFileOptions in interface Protocol.WriteRequestOrBuilder
    
    Returns:
    
    The createUfsFileOptions.
  - setCreateUfsFileOptions
```
public Protocol.WriteRequest.Builder setCreateUfsFileOptions(Protocol.CreateUfsFileOptions value)
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
  - setCreateUfsFileOptions
```
public Protocol.WriteRequest.Builder setCreateUfsFileOptions(Protocol.CreateUfsFileOptions.Builder builderForValue)
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
  - mergeCreateUfsFileOptions
```
public Protocol.WriteRequest.Builder mergeCreateUfsFileOptions(Protocol.CreateUfsFileOptions value)
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
  - clearCreateUfsFileOptions
```
public Protocol.WriteRequest.Builder clearCreateUfsFileOptions()
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
  - getCreateUfsFileOptionsBuilder
```
public Protocol.CreateUfsFileOptions.Builder getCreateUfsFileOptionsBuilder()
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
  - getCreateUfsFileOptionsOrBuilder
```
public Protocol.CreateUfsFileOptionsOrBuilder getCreateUfsFileOptionsOrBuilder()
```
```
 This is only applicable for ufs writes.
 
```
    optional .alluxio.proto.dataserver.CreateUfsFileOptions create_ufs_file_options = 7;
    Specified by:
    
    getCreateUfsFileOptionsOrBuilder in interface Protocol.WriteRequestOrBuilder
  - setUnknownFields
```
public final Protocol.WriteRequest.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.WriteRequest.Builder>
  - mergeUnknownFields
```
public final Protocol.WriteRequest.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.WriteRequest.Builder>

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

hasType

getType

setType

clearType

hasId

getId

setId

clearId

hasOffset

getOffset

setOffset

clearOffset

hasTier

getTier

setTier

clearTier

hasEof

getEof

setEof

clearEof

hasCancel

getCancel

setCancel

clearCancel

hasCreateUfsFileOptions

getCreateUfsFileOptions

setCreateUfsFileOptions

setCreateUfsFileOptions

mergeCreateUfsFileOptions

clearCreateUfsFileOptions

getCreateUfsFileOptionsBuilder

getCreateUfsFileOptionsOrBuilder

setUnknownFields

mergeUnknownFields