alluxio.grpc

Interface ListStatusPartialPOptionsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListStatusPartialPOptions, ListStatusPartialPOptions.Builder

public interface ListStatusPartialPOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getBatchSize() Batch size for partial listings.
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;
String	getPrefix() Only match files with a given prefix.
com.google.protobuf.ByteString	getPrefixBytes() Only match files with a given prefix.
String	getStartAfter() Start the listing after this path.
com.google.protobuf.ByteString	getStartAfterBytes() Start the listing after this path.
boolean	hasBatchSize() Batch size for partial listings.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasOptions

boolean hasOptions()

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

Returns:

Whether the options field is set.

getOptions

ListStatusPOptions getOptions()

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

Returns:

The options.

getOptionsOrBuilder

ListStatusPOptionsOrBuilder getOptionsOrBuilder()

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

hasOffsetId

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;

Returns:

Whether the offsetId field is set.

getOffsetId

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;

Returns:

The offsetId.

hasStartAfter

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;

Returns:

Whether the startAfter field is set.

getStartAfter

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;

Returns:

The startAfter.

getStartAfterBytes

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;

Returns:

The bytes for startAfter.

hasOffsetCount

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;

Returns:

Whether the offsetCount field is set.

getOffsetCount

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;

Returns:

The offsetCount.

hasBatchSize

boolean hasBatchSize()

 Batch size for partial listings.
 

optional int32 batchSize = 5;

Returns:

Whether the batchSize field is set.

getBatchSize

int getBatchSize()

 Batch size for partial listings.
 

optional int32 batchSize = 5;

Returns:

The batchSize.

hasPrefix

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;

Returns:

Whether the prefix field is set.

getPrefix

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;

Returns:

The prefix.

getPrefixBytes

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;

Returns:

The bytes for prefix.

getOffsetTypeCase

ListStatusPartialPOptions.OffsetTypeCase getOffsetTypeCase()