alluxio.proto.status

Enum Status.PStatus

java.lang.Object

java.lang.Enum<Status.PStatus>

alluxio.proto.status.Status.PStatus

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Status.PStatus>

Enclosing class:

Status

public static enum Status.PStatus
extends Enum<Status.PStatus>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum alluxio.proto.status.PStatus

 exception status for a response.
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED ABORTED = 10;
ALREADY_EXISTS ALREADY_EXISTS = 6;
CANCELED CANCELED = 1;
DATA_LOSS DATA_LOSS = 15;
DEADLINE_EXCEEDED DEADLINE_EXCEEDED = 4;
FAILED_PRECONDITION FAILED_PRECONDITION = 9;
INTERNAL INTERNAL = 13;
INVALID_ARGUMENT INVALID_ARGUMENT = 3;
NOT_FOUND NOT_FOUND = 5;
OK OK = 0;
OUT_OF_RANGE OUT_OF_RANGE = 11;
PERMISSION_DENIED PERMISSION_DENIED = 7;
RESOURCE_EXHAUSTED RESOURCE_EXHAUSTED = 8;
UNAUTHENTICATED UNAUTHENTICATED = 16;
UNAVAILABLE UNAVAILABLE = 14;
UNIMPLEMENTED UNIMPLEMENTED = 12;
UNKNOWN UNKNOWN = 2;

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORTED_VALUE ABORTED = 10;
static int	ALREADY_EXISTS_VALUE ALREADY_EXISTS = 6;
static int	CANCELED_VALUE CANCELED = 1;
static int	DATA_LOSS_VALUE DATA_LOSS = 15;
static int	DEADLINE_EXCEEDED_VALUE DEADLINE_EXCEEDED = 4;
static int	FAILED_PRECONDITION_VALUE FAILED_PRECONDITION = 9;
static int	INTERNAL_VALUE INTERNAL = 13;
static int	INVALID_ARGUMENT_VALUE INVALID_ARGUMENT = 3;
static int	NOT_FOUND_VALUE NOT_FOUND = 5;
static int	OK_VALUE OK = 0;
static int	OUT_OF_RANGE_VALUE OUT_OF_RANGE = 11;
static int	PERMISSION_DENIED_VALUE PERMISSION_DENIED = 7;
static int	RESOURCE_EXHAUSTED_VALUE RESOURCE_EXHAUSTED = 8;
static int	UNAUTHENTICATED_VALUE UNAUTHENTICATED = 16;
static int	UNAVAILABLE_VALUE UNAVAILABLE = 14;
static int	UNIMPLEMENTED_VALUE UNIMPLEMENTED = 12;
static int	UNKNOWN_VALUE UNKNOWN = 2;

Method Summary

Modifier and Type	Method and Description
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Status.PStatus>	internalGetValueMap()
static Status.PStatus	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Status.PStatus	valueOf(int value)
static Status.PStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status.PStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final Status.PStatus OK

OK = 0;

 OK is returned on success.
 

CANCELED

public static final Status.PStatus CANCELED

CANCELED = 1;

 Canceled indicates the operation was cancelled (typically by the caller).
 

UNKNOWN

public static final Status.PStatus UNKNOWN

UNKNOWN = 2;

 Unknown error.  An example of where this error may be returned is
 if a Status value received from another address space belongs to
 an error-space that is not known in this address space.  Also
 errors raised by APIs that do not return enough error information
 may be converted to this error.
 

INVALID_ARGUMENT

public static final Status.PStatus INVALID_ARGUMENT

INVALID_ARGUMENT = 3;

 InvalidArgument indicates client specified an invalid argument.
 Note that this differs from FailedPrecondition. It indicates arguments
 that are problematic regardless of the state of the system
 (e.g., a malformed file name).
 

DEADLINE_EXCEEDED

public static final Status.PStatus DEADLINE_EXCEEDED

DEADLINE_EXCEEDED = 4;

 DeadlineExceeded means operation expired before completion.
 For operations that change the state of the system, this error may be
 returned even if the operation has completed successfully. For
 example, a successful response from a server could have been delayed
 long enough for the deadline to expire.
 

NOT_FOUND

public static final Status.PStatus NOT_FOUND

NOT_FOUND = 5;

 NotFound means some requested entity (e.g., file or directory) was
 not found.
 

ALREADY_EXISTS

public static final Status.PStatus ALREADY_EXISTS

ALREADY_EXISTS = 6;

 AlreadyExists means an attempt to create an entity failed because one
 already exists.
 

PERMISSION_DENIED

public static final Status.PStatus PERMISSION_DENIED

PERMISSION_DENIED = 7;

 PermissionDenied indicates the caller does not have permission to
 execute the specified operation. It must not be used for rejections
 caused by exhausting some resource (use ResourceExhausted
 instead for those errors).  It must not be
 used if the caller cannot be identified (use Unauthenticated
 instead for those errors).
 

UNAUTHENTICATED

public static final Status.PStatus UNAUTHENTICATED

UNAUTHENTICATED = 16;

 Unauthenticated indicates the request does not have valid
 authentication credentials for the operation.
 

RESOURCE_EXHAUSTED

public static final Status.PStatus RESOURCE_EXHAUSTED

RESOURCE_EXHAUSTED = 8;

 ResourceExhausted indicates some resource has been exhausted, perhaps
 a per-user quota, or perhaps the entire file system is out of space.
 

FAILED_PRECONDITION

public static final Status.PStatus FAILED_PRECONDITION

FAILED_PRECONDITION = 9;

 FailedPrecondition indicates operation was rejected because the
 system is not in a state required for the operation's execution.
 For example, directory to be deleted may be non-empty, an rmdir
 operation is applied to a non-directory, etc.

 A litmus test that may help a service implementor in deciding
 between FailedPrecondition, Aborted, and Unavailable:
  (a) Use Unavailable if the client can retry just the failing call.
  (b) Use Aborted if the client should retry at a higher-level
      (e.g., restarting a read-modify-write sequence).
  (c) Use FailedPrecondition if the client should not retry until
      the system state has been explicitly fixed.  E.g., if an "rmdir"
      fails because the directory is non-empty, FailedPrecondition
      should be returned since the client should not retry unless
      they have first fixed up the directory by deleting files from it.
  (d) Use FailedPrecondition if the client performs conditional
      REST Get/Update/Delete on a resource and the resource on the
      server does not match the condition. E.g., conflicting
      read-modify-write on the same resource.
 

ABORTED

public static final Status.PStatus ABORTED

ABORTED = 10;

 Aborted indicates the operation was aborted, typically due to a
 concurrency issue like sequencer check failures, transaction aborts,
 etc.

 See litmus test above for deciding between FailedPrecondition,
 Aborted, and Unavailable.
 

OUT_OF_RANGE

public static final Status.PStatus OUT_OF_RANGE

OUT_OF_RANGE = 11;

 OutOfRange means operation was attempted past the valid range.
 E.g., seeking or reading past end of file.

 Unlike InvalidArgument, this error indicates a problem that may
 be fixed if the system state changes. For example, a 32-bit file
 system will generate InvalidArgument if asked to read at an
 offset that is not in the range [0,2^32-1], but it will generate
 OutOfRange if asked to read from an offset past the current
 file size.

 There is a fair bit of overlap between FailedPrecondition and
 OutOfRange.  We recommend using OutOfRange (the more specific
 error) when it applies so that callers who are iterating through
 a space can easily look for an OutOfRange error to detect when
 they are done.
 

UNIMPLEMENTED

public static final Status.PStatus UNIMPLEMENTED

UNIMPLEMENTED = 12;

 Unimplemented indicates operation is not implemented or not
 supported/enabled in this service.
 

INTERNAL

public static final Status.PStatus INTERNAL

INTERNAL = 13;

 Internal errors.  Means some invariants expected by underlying
 system has been broken.  If you see one of these errors,
 something is very broken.
 

UNAVAILABLE

public static final Status.PStatus UNAVAILABLE

UNAVAILABLE = 14;

 Unavailable indicates the service is currently unavailable.
 This is a most likely a transient condition and may be corrected
 by retrying with a backoff.

 See litmus test above for deciding between FailedPrecondition,
 Aborted, and Unavailable.
 

DATA_LOSS

public static final Status.PStatus DATA_LOSS

DATA_LOSS = 15;

 DataLoss indicates unrecoverable data loss or corruption.
 

Field Detail

OK_VALUE

public static final int OK_VALUE

OK = 0;

 OK is returned on success.
 

See Also:

Constant Field Values

CANCELED_VALUE

public static final int CANCELED_VALUE

CANCELED = 1;

 Canceled indicates the operation was cancelled (typically by the caller).
 

See Also:

Constant Field Values

UNKNOWN_VALUE

public static final int UNKNOWN_VALUE

UNKNOWN = 2;

 Unknown error.  An example of where this error may be returned is
 if a Status value received from another address space belongs to
 an error-space that is not known in this address space.  Also
 errors raised by APIs that do not return enough error information
 may be converted to this error.
 

See Also:

Constant Field Values

INVALID_ARGUMENT_VALUE

public static final int INVALID_ARGUMENT_VALUE

INVALID_ARGUMENT = 3;

 InvalidArgument indicates client specified an invalid argument.
 Note that this differs from FailedPrecondition. It indicates arguments
 that are problematic regardless of the state of the system
 (e.g., a malformed file name).
 

See Also:

Constant Field Values

DEADLINE_EXCEEDED_VALUE

public static final int DEADLINE_EXCEEDED_VALUE

DEADLINE_EXCEEDED = 4;

 DeadlineExceeded means operation expired before completion.
 For operations that change the state of the system, this error may be
 returned even if the operation has completed successfully. For
 example, a successful response from a server could have been delayed
 long enough for the deadline to expire.
 

See Also:

Constant Field Values

NOT_FOUND_VALUE

public static final int NOT_FOUND_VALUE

NOT_FOUND = 5;

 NotFound means some requested entity (e.g., file or directory) was
 not found.
 

See Also:

Constant Field Values

ALREADY_EXISTS_VALUE

public static final int ALREADY_EXISTS_VALUE

ALREADY_EXISTS = 6;

 AlreadyExists means an attempt to create an entity failed because one
 already exists.
 

See Also:

Constant Field Values

PERMISSION_DENIED_VALUE

public static final int PERMISSION_DENIED_VALUE

PERMISSION_DENIED = 7;

 PermissionDenied indicates the caller does not have permission to
 execute the specified operation. It must not be used for rejections
 caused by exhausting some resource (use ResourceExhausted
 instead for those errors).  It must not be
 used if the caller cannot be identified (use Unauthenticated
 instead for those errors).
 

See Also:

Constant Field Values

UNAUTHENTICATED_VALUE

public static final int UNAUTHENTICATED_VALUE

UNAUTHENTICATED = 16;

 Unauthenticated indicates the request does not have valid
 authentication credentials for the operation.
 

See Also:

Constant Field Values

RESOURCE_EXHAUSTED_VALUE

public static final int RESOURCE_EXHAUSTED_VALUE

RESOURCE_EXHAUSTED = 8;

 ResourceExhausted indicates some resource has been exhausted, perhaps
 a per-user quota, or perhaps the entire file system is out of space.
 

See Also:

Constant Field Values

FAILED_PRECONDITION_VALUE

public static final int FAILED_PRECONDITION_VALUE

FAILED_PRECONDITION = 9;

 FailedPrecondition indicates operation was rejected because the
 system is not in a state required for the operation's execution.
 For example, directory to be deleted may be non-empty, an rmdir
 operation is applied to a non-directory, etc.

 A litmus test that may help a service implementor in deciding
 between FailedPrecondition, Aborted, and Unavailable:
  (a) Use Unavailable if the client can retry just the failing call.
  (b) Use Aborted if the client should retry at a higher-level
      (e.g., restarting a read-modify-write sequence).
  (c) Use FailedPrecondition if the client should not retry until
      the system state has been explicitly fixed.  E.g., if an "rmdir"
      fails because the directory is non-empty, FailedPrecondition
      should be returned since the client should not retry unless
      they have first fixed up the directory by deleting files from it.
  (d) Use FailedPrecondition if the client performs conditional
      REST Get/Update/Delete on a resource and the resource on the
      server does not match the condition. E.g., conflicting
      read-modify-write on the same resource.
 

See Also:

Constant Field Values

ABORTED_VALUE

public static final int ABORTED_VALUE

ABORTED = 10;

 Aborted indicates the operation was aborted, typically due to a
 concurrency issue like sequencer check failures, transaction aborts,
 etc.

 See litmus test above for deciding between FailedPrecondition,
 Aborted, and Unavailable.
 

See Also:

Constant Field Values

OUT_OF_RANGE_VALUE

public static final int OUT_OF_RANGE_VALUE

OUT_OF_RANGE = 11;

 OutOfRange means operation was attempted past the valid range.
 E.g., seeking or reading past end of file.

 Unlike InvalidArgument, this error indicates a problem that may
 be fixed if the system state changes. For example, a 32-bit file
 system will generate InvalidArgument if asked to read at an
 offset that is not in the range [0,2^32-1], but it will generate
 OutOfRange if asked to read from an offset past the current
 file size.

 There is a fair bit of overlap between FailedPrecondition and
 OutOfRange.  We recommend using OutOfRange (the more specific
 error) when it applies so that callers who are iterating through
 a space can easily look for an OutOfRange error to detect when
 they are done.
 

See Also:

Constant Field Values

UNIMPLEMENTED_VALUE

public static final int UNIMPLEMENTED_VALUE

UNIMPLEMENTED = 12;

 Unimplemented indicates operation is not implemented or not
 supported/enabled in this service.
 

See Also:

Constant Field Values

INTERNAL_VALUE

public static final int INTERNAL_VALUE

INTERNAL = 13;

 Internal errors.  Means some invariants expected by underlying
 system has been broken.  If you see one of these errors,
 something is very broken.
 

See Also:

Constant Field Values

UNAVAILABLE_VALUE

public static final int UNAVAILABLE_VALUE

UNAVAILABLE = 14;

 Unavailable indicates the service is currently unavailable.
 This is a most likely a transient condition and may be corrected
 by retrying with a backoff.

 See litmus test above for deciding between FailedPrecondition,
 Aborted, and Unavailable.
 

See Also:

Constant Field Values

DATA_LOSS_VALUE

public static final int DATA_LOSS_VALUE

DATA_LOSS = 15;

 DataLoss indicates unrecoverable data loss or corruption.
 

See Also:

Constant Field Values

Method Detail

values

public static Status.PStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Status.PStatus c : Status.PStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Status.PStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

public static Status.PStatus valueOf(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Status.PStatus> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Status.PStatus valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)