alluxio.grpc

Class ListStatusPartialPOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

alluxio.grpc.ListStatusPartialPOptions

All Implemented Interfaces:

ListStatusPartialPOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ListStatusPartialPOptions
extends com.google.protobuf.GeneratedMessageV3
implements ListStatusPartialPOptionsOrBuilder

Protobuf type alluxio.grpc.file.ListStatusPartialPOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListStatusPartialPOptions.Builder Protobuf type alluxio.grpc.file.ListStatusPartialPOptions
static class	ListStatusPartialPOptions.OffsetTypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BATCHSIZE_FIELD_NUMBER
static int	OFFSETCOUNT_FIELD_NUMBER
static int	OFFSETID_FIELD_NUMBER
static int	OPTIONS_FIELD_NUMBER
static com.google.protobuf.Parser<ListStatusPartialPOptions>	PARSER Deprecated.
static int	PREFIX_FIELD_NUMBER
static int	STARTAFTER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getBatchSize() Batch size for partial listings.
static ListStatusPartialPOptions	getDefaultInstance()
ListStatusPartialPOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getOffsetCount() Only start listing items after this many items have been processed.
long	getOffsetId() Start listing after the given FileId, the FileId can be calculated from the result of a previous listing's FileInfo or URIStatus results using the getFileId method.
ListStatusPartialPOptions.OffsetTypeCase	getOffsetTypeCase()
ListStatusPOptions	getOptions() optional .alluxio.grpc.file.ListStatusPOptions options = 1;
ListStatusPOptionsOrBuilder	getOptionsOrBuilder() optional .alluxio.grpc.file.ListStatusPOptions options = 1;
com.google.protobuf.Parser<ListStatusPartialPOptions>	getParserForType()
String	getPrefix() Only match files with a given prefix.
com.google.protobuf.ByteString	getPrefixBytes() Only match files with a given prefix.
int	getSerializedSize()
String	getStartAfter() Start the listing after this path.
com.google.protobuf.ByteString	getStartAfterBytes() Start the listing after this path.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBatchSize() Batch size for partial listings.
int	hashCode()
boolean	hasOffsetCount() Only start listing items after this many items have been processed.
boolean	hasOffsetId() Start listing after the given FileId, the FileId can be calculated from the result of a previous listing's FileInfo or URIStatus results using the getFileId method.
boolean	hasOptions() optional .alluxio.grpc.file.ListStatusPOptions options = 1;
boolean	hasPrefix() Only match files with a given prefix.
boolean	hasStartAfter() Start the listing after this path.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListStatusPartialPOptions.Builder	newBuilder()
static ListStatusPartialPOptions.Builder	newBuilder(ListStatusPartialPOptions prototype)
ListStatusPartialPOptions.Builder	newBuilderForType()
protected ListStatusPartialPOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListStatusPartialPOptions	parseDelimitedFrom(InputStream input)
static ListStatusPartialPOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPartialPOptions	parseFrom(byte[] data)
static ListStatusPartialPOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPartialPOptions	parseFrom(ByteBuffer data)
static ListStatusPartialPOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPartialPOptions	parseFrom(com.google.protobuf.ByteString data)
static ListStatusPartialPOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPartialPOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static ListStatusPartialPOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPartialPOptions	parseFrom(InputStream input)
static ListStatusPartialPOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListStatusPartialPOptions>	parser()
ListStatusPartialPOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

OFFSETID_FIELD_NUMBER

public static final int OFFSETID_FIELD_NUMBER

See Also:

Constant Field Values

STARTAFTER_FIELD_NUMBER

public static final int STARTAFTER_FIELD_NUMBER

See Also:

Constant Field Values

OFFSETCOUNT_FIELD_NUMBER

public static final int OFFSETCOUNT_FIELD_NUMBER

See Also:

Constant Field Values

BATCHSIZE_FIELD_NUMBER

public static final int BATCHSIZE_FIELD_NUMBER

See Also:

Constant Field Values

PREFIX_FIELD_NUMBER

public static final int PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<ListStatusPartialPOptions> PARSER

Deprecated.

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getOffsetTypeCase

public ListStatusPartialPOptions.OffsetTypeCase getOffsetTypeCase()

Specified by:

getOffsetTypeCase in interface ListStatusPartialPOptionsOrBuilder

hasOptions

public boolean hasOptions()

optional .alluxio.grpc.file.ListStatusPOptions options = 1;

Specified by:

hasOptions in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the options field is set.

getOptions

public ListStatusPOptions getOptions()

optional .alluxio.grpc.file.ListStatusPOptions options = 1;

Specified by:

getOptions in interface ListStatusPartialPOptionsOrBuilder

Returns:

The options.

getOptionsOrBuilder

public ListStatusPOptionsOrBuilder getOptionsOrBuilder()

optional .alluxio.grpc.file.ListStatusPOptions options = 1;

Specified by:

getOptionsOrBuilder in interface ListStatusPartialPOptionsOrBuilder

hasOffsetId

public boolean hasOffsetId()

 Start listing after the given FileId, the FileId can be calculated from the
 result of a previous listing's FileInfo or URIStatus results using the
 getFileId method. If the file with the given ID has been moved or deleted
 then the call will return an error.
 

int64 offsetId = 2;

Specified by:

hasOffsetId in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the offsetId field is set.

getOffsetId

public long getOffsetId()

 Start listing after the given FileId, the FileId can be calculated from the
 result of a previous listing's FileInfo or URIStatus results using the
 getFileId method. If the file with the given ID has been moved or deleted
 then the call will return an error.
 

int64 offsetId = 2;

Specified by:

getOffsetId in interface ListStatusPartialPOptionsOrBuilder

Returns:

The offsetId.

hasStartAfter

public boolean hasStartAfter()

 Start the listing after this path.
 If startAfter starts with "/", then it is expected that the path given in
 the ListStatusPartialPRequest is a prefix of startAfter (e.g. if listing "/dir",
 then startAfter could be "/dir/next"). Otherwise if start after does not start with "/",
 then startAfter is appended to the path given in the ListStatusPartialPRequest
 (e.g. if the listing path is "/dir" and startAfter is "/after" then files that
 start after "/dir/after" in lexicographic order will be listed).
 The full path itself does not need to exist.
 This offset type is recommended to use if POSIX compatible listings are needed.
 

string startAfter = 3;

Specified by:

hasStartAfter in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the startAfter field is set.

getStartAfter

public String getStartAfter()

 Start the listing after this path.
 If startAfter starts with "/", then it is expected that the path given in
 the ListStatusPartialPRequest is a prefix of startAfter (e.g. if listing "/dir",
 then startAfter could be "/dir/next"). Otherwise if start after does not start with "/",
 then startAfter is appended to the path given in the ListStatusPartialPRequest
 (e.g. if the listing path is "/dir" and startAfter is "/after" then files that
 start after "/dir/after" in lexicographic order will be listed).
 The full path itself does not need to exist.
 This offset type is recommended to use if POSIX compatible listings are needed.
 

string startAfter = 3;

Specified by:

getStartAfter in interface ListStatusPartialPOptionsOrBuilder

Returns:

The startAfter.

getStartAfterBytes

public com.google.protobuf.ByteString getStartAfterBytes()

 Start the listing after this path.
 If startAfter starts with "/", then it is expected that the path given in
 the ListStatusPartialPRequest is a prefix of startAfter (e.g. if listing "/dir",
 then startAfter could be "/dir/next"). Otherwise if start after does not start with "/",
 then startAfter is appended to the path given in the ListStatusPartialPRequest
 (e.g. if the listing path is "/dir" and startAfter is "/after" then files that
 start after "/dir/after" in lexicographic order will be listed).
 The full path itself does not need to exist.
 This offset type is recommended to use if POSIX compatible listings are needed.
 

string startAfter = 3;

Specified by:

getStartAfterBytes in interface ListStatusPartialPOptionsOrBuilder

Returns:

The bytes for startAfter.

hasOffsetCount

public boolean hasOffsetCount()

 Only start listing items after this many items have been processed.
 This will count from the start of the listing up to offsetCont
 before listing items. This can be useful for example to show
 individual pages in a UI. Note that this listing type may
 be more expensive than the others as it must traverse offsetCount
 items, while the others reach the listing point by querying
 a skip list.
 

int32 offsetCount = 4;

Specified by:

hasOffsetCount in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the offsetCount field is set.

getOffsetCount

public int getOffsetCount()

 Only start listing items after this many items have been processed.
 This will count from the start of the listing up to offsetCont
 before listing items. This can be useful for example to show
 individual pages in a UI. Note that this listing type may
 be more expensive than the others as it must traverse offsetCount
 items, while the others reach the listing point by querying
 a skip list.
 

int32 offsetCount = 4;

Specified by:

getOffsetCount in interface ListStatusPartialPOptionsOrBuilder

Returns:

The offsetCount.

hasBatchSize

public boolean hasBatchSize()

 Batch size for partial listings.
 

optional int32 batchSize = 5;

Specified by:

hasBatchSize in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the batchSize field is set.

getBatchSize

public int getBatchSize()

 Batch size for partial listings.
 

optional int32 batchSize = 5;

Specified by:

getBatchSize in interface ListStatusPartialPOptionsOrBuilder

Returns:

The batchSize.

hasPrefix

public boolean hasPrefix()

 Only match files with a given prefix.
 The prefix starts after the given listing path
 (e.g. if "/dir" is being listed and prefix is "/pre", then
 any file with path having a prefix of "/dir/pre" will be listed).
 

optional string prefix = 6;

Specified by:

hasPrefix in interface ListStatusPartialPOptionsOrBuilder

Returns:

Whether the prefix field is set.

getPrefix

public String getPrefix()

 Only match files with a given prefix.
 The prefix starts after the given listing path
 (e.g. if "/dir" is being listed and prefix is "/pre", then
 any file with path having a prefix of "/dir/pre" will be listed).
 

optional string prefix = 6;

Specified by:

getPrefix in interface ListStatusPartialPOptionsOrBuilder

Returns:

The prefix.

getPrefixBytes

public com.google.protobuf.ByteString getPrefixBytes()

 Only match files with a given prefix.
 The prefix starts after the given listing path
 (e.g. if "/dir" is being listed and prefix is "/pre", then
 any file with path having a prefix of "/dir/pre" will be listed).
 

optional string prefix = 6;

Specified by:

getPrefixBytes in interface ListStatusPartialPOptionsOrBuilder

Returns:

The bytes for prefix.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListStatusPartialPOptions parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPartialPOptions parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static ListStatusPartialPOptions parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListStatusPartialPOptions parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListStatusPartialPOptions parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static ListStatusPartialPOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static ListStatusPartialPOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public ListStatusPartialPOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListStatusPartialPOptions.Builder newBuilder()

newBuilder

public static ListStatusPartialPOptions.Builder newBuilder(ListStatusPartialPOptions prototype)

toBuilder

public ListStatusPartialPOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListStatusPartialPOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListStatusPartialPOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListStatusPartialPOptions> parser()

getParserForType

public com.google.protobuf.Parser<ListStatusPartialPOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ListStatusPartialPOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder