alluxio.grpc

Class ListStatusPOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

alluxio.grpc.ListStatusPOptions

All Implemented Interfaces:

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

public final class ListStatusPOptions
extends com.google.protobuf.GeneratedMessageV3
implements ListStatusPOptionsOrBuilder

Protobuf type alluxio.grpc.file.ListStatusPOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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	COMMONOPTIONS_FIELD_NUMBER
static int	DISABLEAREDESCENDANTSLOADEDCHECK_FIELD_NUMBER
static int	EXCLUDEMOUNTINFO_FIELD_NUMBER
static int	LOADDIRECTCHILDREN_FIELD_NUMBER
static int	LOADMETADATAONLY_FIELD_NUMBER
static int	LOADMETADATATYPE_FIELD_NUMBER
static com.google.protobuf.Parser<ListStatusPOptions>	PARSER Deprecated.
static int	RECURSIVE_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)
FileSystemMasterCommonPOptions	getCommonOptions() optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;
FileSystemMasterCommonPOptionsOrBuilder	getCommonOptionsOrBuilder() optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;
static ListStatusPOptions	getDefaultInstance()
ListStatusPOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDisableAreDescendantsLoadedCheck() Setting this to true will disable checking during metadata sync to see if the children of a directory has been loaded.
boolean	getExcludeMountInfo() Mount info will be excluded from the list status response if this field is set to true.
boolean	getLoadDirectChildren() This is deprecated since 1.1.1 and will be removed in 2.0.
boolean	getLoadMetadataOnly() No data will be transferred.
LoadMetadataPType	getLoadMetadataType() optional .alluxio.grpc.file.LoadMetadataPType loadMetadataType = 2;
com.google.protobuf.Parser<ListStatusPOptions>	getParserForType()
boolean	getRecursive() optional bool recursive = 4;
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCommonOptions() optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;
boolean	hasDisableAreDescendantsLoadedCheck() Setting this to true will disable checking during metadata sync to see if the children of a directory has been loaded.
boolean	hasExcludeMountInfo() Mount info will be excluded from the list status response if this field is set to true.
int	hashCode()
boolean	hasLoadDirectChildren() This is deprecated since 1.1.1 and will be removed in 2.0.
boolean	hasLoadMetadataOnly() No data will be transferred.
boolean	hasLoadMetadataType() optional .alluxio.grpc.file.LoadMetadataPType loadMetadataType = 2;
boolean	hasRecursive() optional bool recursive = 4;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListStatusPOptions.Builder	newBuilder()
static ListStatusPOptions.Builder	newBuilder(ListStatusPOptions prototype)
ListStatusPOptions.Builder	newBuilderForType()
protected ListStatusPOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListStatusPOptions	parseDelimitedFrom(InputStream input)
static ListStatusPOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPOptions	parseFrom(byte[] data)
static ListStatusPOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPOptions	parseFrom(ByteBuffer data)
static ListStatusPOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPOptions	parseFrom(com.google.protobuf.ByteString data)
static ListStatusPOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static ListStatusPOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListStatusPOptions	parseFrom(InputStream input)
static ListStatusPOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListStatusPOptions>	parser()
ListStatusPOptions.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

LOADDIRECTCHILDREN_FIELD_NUMBER

public static final int LOADDIRECTCHILDREN_FIELD_NUMBER

See Also:

Constant Field Values

LOADMETADATATYPE_FIELD_NUMBER

public static final int LOADMETADATATYPE_FIELD_NUMBER

See Also:

Constant Field Values

COMMONOPTIONS_FIELD_NUMBER

public static final int COMMONOPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

RECURSIVE_FIELD_NUMBER

public static final int RECURSIVE_FIELD_NUMBER

See Also:

Constant Field Values

LOADMETADATAONLY_FIELD_NUMBER

public static final int LOADMETADATAONLY_FIELD_NUMBER

See Also:

Constant Field Values

DISABLEAREDESCENDANTSLOADEDCHECK_FIELD_NUMBER

public static final int DISABLEAREDESCENDANTSLOADEDCHECK_FIELD_NUMBER

See Also:

Constant Field Values

EXCLUDEMOUNTINFO_FIELD_NUMBER

public static final int EXCLUDEMOUNTINFO_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<ListStatusPOptions> 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

hasLoadDirectChildren

public boolean hasLoadDirectChildren()

 This is deprecated since 1.1.1 and will be removed in 2.0. Use loadMetadataType.
 

optional bool loadDirectChildren = 1;

Specified by:

hasLoadDirectChildren in interface ListStatusPOptionsOrBuilder

Returns:

Whether the loadDirectChildren field is set.

getLoadDirectChildren

public boolean getLoadDirectChildren()

 This is deprecated since 1.1.1 and will be removed in 2.0. Use loadMetadataType.
 

optional bool loadDirectChildren = 1;

Specified by:

getLoadDirectChildren in interface ListStatusPOptionsOrBuilder

Returns:

The loadDirectChildren.

hasLoadMetadataType

public boolean hasLoadMetadataType()

optional .alluxio.grpc.file.LoadMetadataPType loadMetadataType = 2;

Specified by:

hasLoadMetadataType in interface ListStatusPOptionsOrBuilder

Returns:

Whether the loadMetadataType field is set.

getLoadMetadataType

public LoadMetadataPType getLoadMetadataType()

optional .alluxio.grpc.file.LoadMetadataPType loadMetadataType = 2;

Specified by:

getLoadMetadataType in interface ListStatusPOptionsOrBuilder

Returns:

The loadMetadataType.

hasCommonOptions

public boolean hasCommonOptions()

optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;

Specified by:

hasCommonOptions in interface ListStatusPOptionsOrBuilder

Returns:

Whether the commonOptions field is set.

getCommonOptions

public FileSystemMasterCommonPOptions getCommonOptions()

optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;

Specified by:

getCommonOptions in interface ListStatusPOptionsOrBuilder

Returns:

The commonOptions.

getCommonOptionsOrBuilder

public FileSystemMasterCommonPOptionsOrBuilder getCommonOptionsOrBuilder()

optional .alluxio.grpc.file.FileSystemMasterCommonPOptions commonOptions = 3;

Specified by:

getCommonOptionsOrBuilder in interface ListStatusPOptionsOrBuilder

hasRecursive

public boolean hasRecursive()

optional bool recursive = 4;

Specified by:

hasRecursive in interface ListStatusPOptionsOrBuilder

Returns:

Whether the recursive field is set.

getRecursive

public boolean getRecursive()

optional bool recursive = 4;

Specified by:

getRecursive in interface ListStatusPOptionsOrBuilder

Returns:

The recursive.

hasLoadMetadataOnly

public boolean hasLoadMetadataOnly()

 No data will be transferred.
 

optional bool loadMetadataOnly = 5;

Specified by:

hasLoadMetadataOnly in interface ListStatusPOptionsOrBuilder

Returns:

Whether the loadMetadataOnly field is set.

getLoadMetadataOnly

public boolean getLoadMetadataOnly()

 No data will be transferred.
 

optional bool loadMetadataOnly = 5;

Specified by:

getLoadMetadataOnly in interface ListStatusPOptionsOrBuilder

Returns:

The loadMetadataOnly.

hasDisableAreDescendantsLoadedCheck

public boolean hasDisableAreDescendantsLoadedCheck()

 Setting this to true will disable checking during metadata sync to see if the children
 of a directory has been loaded. This will avoid a costly full traversal of the file
 system during recursive listings, but may result in the children of directories not
 being loaded. It is recommended to set this to true after the first call of a
 recursive partial listing.
 

optional bool disableAreDescendantsLoadedCheck = 6;

Specified by:

hasDisableAreDescendantsLoadedCheck in interface ListStatusPOptionsOrBuilder

Returns:

Whether the disableAreDescendantsLoadedCheck field is set.

getDisableAreDescendantsLoadedCheck

public boolean getDisableAreDescendantsLoadedCheck()

 Setting this to true will disable checking during metadata sync to see if the children
 of a directory has been loaded. This will avoid a costly full traversal of the file
 system during recursive listings, but may result in the children of directories not
 being loaded. It is recommended to set this to true after the first call of a
 recursive partial listing.
 

optional bool disableAreDescendantsLoadedCheck = 6;

Specified by:

getDisableAreDescendantsLoadedCheck in interface ListStatusPOptionsOrBuilder

Returns:

The disableAreDescendantsLoadedCheck.

hasExcludeMountInfo

public boolean hasExcludeMountInfo()

 Mount info will be excluded from the list status response if this field is set to true.
 Resolving a path and obtain the mount info is an expensive operation.
 For clients that do not need this information such as hadoop-compatible clients,
 excluding mount info improves the endpoint performance.
 

optional bool excludeMountInfo = 7;

Specified by:

hasExcludeMountInfo in interface ListStatusPOptionsOrBuilder

Returns:

Whether the excludeMountInfo field is set.

getExcludeMountInfo

public boolean getExcludeMountInfo()

 Mount info will be excluded from the list status response if this field is set to true.
 Resolving a path and obtain the mount info is an expensive operation.
 For clients that do not need this information such as hadoop-compatible clients,
 excluding mount info improves the endpoint performance.
 

optional bool excludeMountInfo = 7;

Specified by:

getExcludeMountInfo in interface ListStatusPOptionsOrBuilder

Returns:

The excludeMountInfo.

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 ListStatusPOptions parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListStatusPOptions parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ListStatusPOptions parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ListStatusPOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListStatusPOptions.Builder newBuilder()

newBuilder

public static ListStatusPOptions.Builder newBuilder(ListStatusPOptions prototype)

toBuilder

public ListStatusPOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListStatusPOptions getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ListStatusPOptions> 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 ListStatusPOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder